proguard

Class ClassSpecification

java.lang.Object

proguard.ClassSpecification

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

KeepClassSpecification

public class ClassSpecification
extends Object
implements Cloneable

This class stores a specification of classes and possibly class members. The specification is template-based: the class names and class member names and descriptors can contain wildcards. Classes can be specified explicitly, or as extensions or implementations in the class hierarchy.

Author:

Eric Lafortune

Field Summary

Fields

Modifier and Type	Field and Description
String	annotationType
String	className
String	comments
String	extendsAnnotationType
String	extendsClassName
List	fieldSpecifications
List	methodSpecifications
int	requiredSetAccessFlags
int	requiredUnsetAccessFlags

Constructor Summary

Constructors

Constructor and Description
ClassSpecification() Creates a new ClassSpecification for all possible classes, without comments or class members.
ClassSpecification(ClassSpecification classSpecification) Creates a new ClassSpecification that is a copy of the given specification.
ClassSpecification(String comments, int requiredSetAccessFlags, int requiredUnsetAccessFlags, String annotationType, String className, String extendsAnnotationType, String extendsClassName) Creates a new ClassSpecification for the specified class(es), without class members.
ClassSpecification(String comments, int requiredSetAccessFlags, int requiredUnsetAccessFlags, String annotationType, String className, String extendsAnnotationType, String extendsClassName, List fieldSpecifications, List methodSpecifications) Creates a new ClassSpecification for the specified classes and class members.

Method Summary

Methods

Modifier and Type	Method and Description
void	addField(MemberSpecification fieldSpecification) Specifies to keep the specified field(s) of this option's class(es).
void	addMethod(MemberSpecification methodSpecification) Specifies to keep the specified method(s) of this option's class(es).
Object	clone()
boolean	equals(Object object)
int	hashCode()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

comments

public final String comments

requiredSetAccessFlags

public int requiredSetAccessFlags

requiredUnsetAccessFlags

public int requiredUnsetAccessFlags

annotationType

public final String annotationType

className

public String className

extendsAnnotationType

public final String extendsAnnotationType

extendsClassName

public final String extendsClassName

fieldSpecifications

public List fieldSpecifications

methodSpecifications

public List methodSpecifications

Constructor Detail

ClassSpecification

public ClassSpecification()

Creates a new ClassSpecification for all possible classes, without comments or class members.

ClassSpecification

public ClassSpecification(ClassSpecification classSpecification)

Creates a new ClassSpecification that is a copy of the given specification.

ClassSpecification

public ClassSpecification(String comments,
                  int requiredSetAccessFlags,
                  int requiredUnsetAccessFlags,
                  String annotationType,
                  String className,
                  String extendsAnnotationType,
                  String extendsClassName)

Creates a new ClassSpecification for the specified class(es), without class members.

Parameters:

comments - provides optional comments on this specification.

requiredSetAccessFlags - the class access flags that must be set in order for the class to apply.

requiredUnsetAccessFlags - the class access flags that must be unset in order for the class to apply.

annotationType - the name of the class that must be an annotation of the class in order for it to apply. The name may be null to specify that no annotation is required.

className - the class name. The name may be null to specify any class, or it may contain "**", "*", or "?" wildcards.

extendsAnnotationType - the name of the class of that must be an annotation of the class that the class must extend or implement in order to apply. The name may be null to specify that no annotation is required.

extendsClassName - the name of the class that the class must extend or implement in order to apply. The name may be null to specify any class.

ClassSpecification

public ClassSpecification(String comments,
                  int requiredSetAccessFlags,
                  int requiredUnsetAccessFlags,
                  String annotationType,
                  String className,
                  String extendsAnnotationType,
                  String extendsClassName,
                  List fieldSpecifications,
                  List methodSpecifications)

Creates a new ClassSpecification for the specified classes and class members.

Parameters:

comments - provides optional comments on this specification.

requiredSetAccessFlags - the class access flags that must be set in order for the class to apply.

requiredUnsetAccessFlags - the class access flags that must be unset in order for the class to apply.

annotationType - the name of the class that must be an annotation of the class in order for it to apply. The name may be null to specify that no annotation is required.

className - the class name. The name may be null to specify any class, or it may contain "**", "*", or "?" wildcards.

extendsAnnotationType - the name of the class of that must be an annotation of the class that the class must extend or implement in order to apply. The name may be null to specify that no annotation is required.

extendsClassName - the name of the class that the class must extend or implement in order to apply. The name may be null to specify any class.

fieldSpecifications - the field specifications.

methodSpecifications - the method specifications.

Method Detail

addField

public void addField(MemberSpecification fieldSpecification)

Specifies to keep the specified field(s) of this option's class(es).

Parameters:

fieldSpecification - the field specification.

addMethod

public void addMethod(MemberSpecification methodSpecification)

Specifies to keep the specified method(s) of this option's class(es).

Parameters:

methodSpecification - the method specification.

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public Object clone()

Overrides:

clone in class Object