Signature (ProGuardCORE)

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 and Description
`protected java.lang.String`	`className`
`protected java.lang.String`	`fqn`
`protected java.lang.String`	`packageName`
`protected java.lang.String`	`prettyFqn`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Signature(java.lang.String className)

Constructors
Modifier	Constructor and Description
`protected`	`Signature(java.lang.String className)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and 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`	`getFqn()`
`java.lang.String`	`getPackageName()`
`java.lang.String`	`getPrettyFqn()`
`int`	`hashCode()`
`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
```
  - packageName
```
protected final java.lang.String packageName
```
  - className
```
protected final java.lang.String className
```
- Constructor Detail
  - Signature
```
protected Signature(java.lang.String className)
```
- Method Detail
  - 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
```
public java.lang.String getPackageName()
```
  - getClassName
```
public java.lang.String getClassName()
```
  - calculateFqn
```
protected abstract java.lang.String calculateFqn()
```
  - calculatePrettyFqn
```
protected abstract java.lang.String calculatePrettyFqn()
```
  - 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

Class Signature

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

fqn

prettyFqn

packageName

className

Constructor Detail

Signature

Method Detail

of

computeIfAbsent

clearCache

setCacheEnabled

getFqn

getPrettyFqn

getPackageName

getClassName

calculateFqn

calculatePrettyFqn

equals

hashCode

compareTo

toString