Package proguard.classfile

Class Signature

java.lang.Object

proguard.classfile.Signature

All Implemented Interfaces:

java.lang.Comparable<Signature>

Direct Known Subclasses:

ClassSignature, FieldSignature, MethodSignature

public abstract class Signature
extends java.lang.Object
implements java.lang.Comparable<Signature>

A signature currently can be a Method- or a FieldSignature. This class can be used to create the correct one from a ProguardCORE member object (which can also be a method or a field).

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	className
protected java.lang.String	fqn
protected int	hashCode
protected java.lang.String	prettyFqn
protected @Nullable Clazz	referencedClass	The Clazz that the className references.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Signature(java.lang.String internalClassName, int hashCode)

Method Summary

Modifier and Type	Method	Description
protected abstract java.lang.String	calculateFqn()
protected abstract java.lang.String	calculatePrettyFqn()
static void	clearCache()	Clear the signature caches of all Signature subclasses.
int	compareTo(Signature o)
static Signature	computeIfAbsent(Clazz clazz, Member member)	This factory uses the caching features provided by MethodSignature.computeIfAbsent(Clazz, Method), FieldSignature.computeIfAbsent(Clazz, Field) and ClassSignature.computeIfAbsent(Clazz).
boolean	equals(java.lang.Object o)
java.lang.String	getClassName()
java.lang.String	getExternalPackageName()
java.lang.String	getFqn()
java.lang.String	getPackageName()	Deprecated.
java.lang.String	getPrettyFqn()
@Nullable Clazz	getReferencedClass()	Returns the Clazz reference corresponding to the class returned by getClassName() or null if no reference is available (e.g.
int	hashCode()
abstract boolean	isIncomplete()	Check if this signature is missing information.
static Signature	of(Clazz clazz, Member member)	Convenience factory that takes any Member and generates the appropriate signature, i.e.
static void	setCacheEnabled(boolean cacheEnabled)	Enable or disable automatic caching in of(Clazz, Member).
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

fqn

protected java.lang.String fqn

prettyFqn

protected java.lang.String prettyFqn

className

protected final java.lang.String className

hashCode

protected final int hashCode

referencedClass

@Nullable
protected @Nullable Clazz referencedClass

The Clazz that the className references. May be null if there is no reference available (e.g. class is missing from the class pool).

Constructor Detail

Signature

protected Signature(java.lang.String internalClassName,
                    int hashCode)

Method Detail

isIncomplete

public abstract boolean isIncomplete()

Check if this signature is missing information.

of

public static Signature of(Clazz clazz,
                           Member member)

Convenience factory that takes any Member and generates the appropriate signature, i.e. MethodSignatures for Methods and FieldSignatures for Fields. If the member is null, a ClassSignature is generated.

Note that if cacheEnabled is set to true, the generation process is delegated to computeIfAbsent(Clazz, Member) to make use of caching features.

Parameters:

clazz - The class containing the member

member - The target member

Returns:

The corresponding Signature object

computeIfAbsent

public static Signature computeIfAbsent(Clazz clazz,
                                        Member member)

This factory uses the caching features provided by MethodSignature.computeIfAbsent(Clazz, Method), FieldSignature.computeIfAbsent(Clazz, Field) and ClassSignature.computeIfAbsent(Clazz). Only one signature is created for each distinct Method, Field or Clazz. If the same signature is requested several times, the previously created object will be returned.

Parameters:

clazz - The class containing the member

member - The target member

Returns:

The corresponding Signature object

clearCache

public static void clearCache()

Clear the signature caches of all Signature subclasses.

setCacheEnabled

public static void setCacheEnabled(boolean cacheEnabled)

Enable or disable automatic caching in of(Clazz, Member). Existing caches are purged once caching has been disabled.

getFqn

public java.lang.String getFqn()

getPrettyFqn

public java.lang.String getPrettyFqn()

getPackageName

@Deprecated
public java.lang.String getPackageName()

Deprecated.

getExternalPackageName

public java.lang.String getExternalPackageName()

Returns:

the external package name (e.g., `java.lang` for `java.lang.Object`)

getClassName

public java.lang.String getClassName()

calculateFqn

protected abstract java.lang.String calculateFqn()

calculatePrettyFqn

protected abstract java.lang.String calculatePrettyFqn()

getReferencedClass

@Nullable
public @Nullable Clazz getReferencedClass()

Returns the Clazz reference corresponding to the class returned by getClassName() or null if no reference is available (e.g. class is missing from the class pool).

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(Signature o)

Specified by:

compareTo in interface java.lang.Comparable<Signature>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object