randoop.reflection

Class OperationExtractor

java.lang.Object

randoop.reflection.DefaultClassVisitor

randoop.reflection.OperationExtractor

All Implemented Interfaces:

ClassVisitor

public class OperationExtractor
extends DefaultClassVisitor

OperationExtractor is a ClassVisitor that creates a collection of TypedOperation objects for a particular ClassOrInterfaceType through its visit methods as called by ReflectionManager.apply(Class).

The returned operations (available by calling the getOperations() method) contain any relevant specification from operationSpecifications.

See Also:

ReflectionManager, ClassVisitor

Field Summary

Fields

Modifier and Type	Field and Description
private AccessibilityPredicate	accessibilityPredicate The predicate to test accessibility.
private ClassOrInterfaceType	classType The type of the declaring class for the collected operations.
private static boolean	debug Whether to produce debugging output to the Randoop log.
private OmitMethodsPredicate	omitPredicate The predicate to test whether to omit an operation.
private java.util.Collection<TypedOperation>	operations The operations collected by the extractor.
private SpecificationCollection	operationSpecifications The specifications (pre/post/throws-conditions).
private ReflectionPredicate	reflectionPredicate The reflection policy for collecting operations.

Constructor Summary

Constructors

Constructor and Description
OperationExtractor(ClassOrInterfaceType classType, ReflectionPredicate reflectionPredicate, AccessibilityPredicate accessibilityPredicate) Creates a visitor object that collects the TypedOperation objects corresponding to members of the class satisfying the given accessibility and reflection predicates.
OperationExtractor(ClassOrInterfaceType classType, ReflectionPredicate reflectionPredicate, OmitMethodsPredicate omitPredicate, AccessibilityPredicate accessibilityPredicate) Creates a visitor object that collects the TypedOperation objects corresponding to members of the class satisfying the given accessibility and reflection predicates.
OperationExtractor(ClassOrInterfaceType classType, ReflectionPredicate reflectionPredicate, OmitMethodsPredicate omitPredicate, AccessibilityPredicate accessibilityPredicate, SpecificationCollection operationSpecifications) Creates a visitor object that collects the TypedOperation objects corresponding to members of the class satisfying the given accessibility and reflection predicates and that don't violate the omit method predicate.

Method Summary

Modifier and Type	Method and Description
private void	checkSubTypes(TypedClassOperation operation) Ensures that field classType of this object is a subtype of operation.getDeclaringType(); throws an exception if not.
static java.util.List<ClassOrInterfaceType>	classListToTypeList(java.util.List<java.lang.Class<?>> classes) Converts a list of classes to a list of ClassOrInterfaceType.
java.util.Collection<TypedOperation>	getOperations() Returns the TypedOperation objects collected for classType.
private TypedClassOperation	instantiateTypes(TypedClassOperation operation) Updates the operation types in the case that operation.getDeclaringType() is generic, but classType is not.
static java.util.List<TypedOperation>	operations(java.lang.Class<?> clazz, ReflectionPredicate reflectionPredicate, AccessibilityPredicate accessibilityPredicate) Returns the operations in the class that satisfy the given predicates.
static java.util.List<TypedOperation>	operations(java.lang.Class<?> clazz, ReflectionPredicate reflectionPredicate, OmitMethodsPredicate omitPredicate, AccessibilityPredicate accessibilityPredicate) Returns the operations in the class that satisfy the given predicates.
static java.util.List<TypedOperation>	operations(java.lang.Class<?> clazz, ReflectionPredicate reflectionPredicate, OmitMethodsPredicate omitMethodsPredicate, AccessibilityPredicate accessibilityPredicate, SpecificationCollection operationSpecifications) Returns the operations in the class that satisfy the given predicates.
static java.util.List<TypedOperation>	operations(ClassOrInterfaceType classType, ReflectionPredicate reflectionPredicate, AccessibilityPredicate accessibilityPredicate) Returns the operations in the class that satisfy the given predicates.
static java.util.List<TypedOperation>	operations(ClassOrInterfaceType classType, ReflectionPredicate reflectionPredicate, OmitMethodsPredicate omitPredicate, AccessibilityPredicate accessibilityPredicate) Returns the operations in the class that satisfy the given predicates.
static java.util.List<TypedOperation>	operations(ClassOrInterfaceType classType, ReflectionPredicate reflectionPredicate, OmitMethodsPredicate omitMethodsPredicate, AccessibilityPredicate accessibilityPredicate, SpecificationCollection operationSpecifications) Returns the operations in the class that satisfy the given predicates.
static java.util.List<TypedOperation>	operations(java.util.Collection<ClassOrInterfaceType> classTypes, ReflectionPredicate reflectionPredicate, AccessibilityPredicate accessibilityPredicate) Returns the operations in the class that satisfy the given predicates.
static java.util.List<TypedOperation>	operations(java.util.Collection<ClassOrInterfaceType> classTypes, ReflectionPredicate reflectionPredicate, OmitMethodsPredicate omitPredicate, AccessibilityPredicate accessibilityPredicate) Returns the operations in the class that satisfy the given predicates.
static java.util.List<TypedOperation>	operations(java.util.Collection<ClassOrInterfaceType> classTypes, ReflectionPredicate reflectionPredicate, OmitMethodsPredicate omitMethodsPredicate, AccessibilityPredicate accessibilityPredicate, SpecificationCollection operationSpecifications) Returns the operations in the class that satisfy the given predicates.
void	visit(java.lang.reflect.Constructor<?> constructor) Creates a ConstructorCall object for the Constructor.
void	visit(java.lang.Enum<?> e) Creates a EnumConstant object for the Enum.
void	visit(java.lang.reflect.Field field) Adds the Operation objects corresponding to getters and setters appropriate to the kind of field.
void	visit(java.lang.reflect.Method method) Creates a MethodCall object for the Method.

Methods inherited from class randoop.reflection.DefaultClassVisitor

toString, visit, visitAfter, visitBefore

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

debug

private static boolean debug

Whether to produce debugging output to the Randoop log.

classType

private ClassOrInterfaceType classType

The type of the declaring class for the collected operations.

operations

private final java.util.Collection<TypedOperation> operations

The operations collected by the extractor. This is the product of applying the visitor.

reflectionPredicate

private final ReflectionPredicate reflectionPredicate

The reflection policy for collecting operations.

omitPredicate

private OmitMethodsPredicate omitPredicate

The predicate to test whether to omit an operation.

accessibilityPredicate

private final AccessibilityPredicate accessibilityPredicate

The predicate to test accessibility.

operationSpecifications

private final SpecificationCollection operationSpecifications

The specifications (pre/post/throws-conditions). Any relevant one is added to the execSpec field of the returned TypedOperation.

Constructor Detail

OperationExtractor

public OperationExtractor(ClassOrInterfaceType classType,
                          ReflectionPredicate reflectionPredicate,
                          OmitMethodsPredicate omitPredicate,
                          AccessibilityPredicate accessibilityPredicate,
                          SpecificationCollection operationSpecifications)

Creates a visitor object that collects the TypedOperation objects corresponding to members of the class satisfying the given accessibility and reflection predicates and that don't violate the omit method predicate.

Once created this visitor should only be applied to members of classType.getRuntimeType().

Parameters:

classType - the declaring class for collected operations

reflectionPredicate - the reflection predicate

omitPredicate - the list of Pattern objects for omitting methods, may be null

accessibilityPredicate - the predicate for test accessibility

operationSpecifications - the specifications (pre/post/throws-conditions)

OperationExtractor

public OperationExtractor(ClassOrInterfaceType classType,
                          ReflectionPredicate reflectionPredicate,
                          AccessibilityPredicate accessibilityPredicate)

Creates a visitor object that collects the TypedOperation objects corresponding to members of the class satisfying the given accessibility and reflection predicates.

Parameters:

classType - the declaring class for collected operations

reflectionPredicate - the reflection predicate

accessibilityPredicate - the predicate for test accessibility

OperationExtractor

public OperationExtractor(ClassOrInterfaceType classType,
                          ReflectionPredicate reflectionPredicate,
                          OmitMethodsPredicate omitPredicate,
                          AccessibilityPredicate accessibilityPredicate)

Creates a visitor object that collects the TypedOperation objects corresponding to members of the class satisfying the given accessibility and reflection predicates.

Parameters:

classType - the declaring class for collected operations

reflectionPredicate - the reflection predicate

omitPredicate - the list of Pattern objects for omitting methods, may be null

accessibilityPredicate - the predicate for test accessibility

Method Detail

operations

public static java.util.List<TypedOperation> operations(java.lang.Class<?> clazz,
                                                        ReflectionPredicate reflectionPredicate,
                                                        AccessibilityPredicate accessibilityPredicate)

Returns the operations in the class that satisfy the given predicates.

Parameters:

clazz - the declaring class for collected operations

reflectionPredicate - the reflection predicate

accessibilityPredicate - the predicate for test accessibility

Returns:

the operations in the class that sastisfy the given predicates

operations

public static java.util.List<TypedOperation> operations(ClassOrInterfaceType classType,
                                                        ReflectionPredicate reflectionPredicate,
                                                        AccessibilityPredicate accessibilityPredicate)

Returns the operations in the class that satisfy the given predicates.

Parameters:

classType - the declaring class for collected operations

reflectionPredicate - the reflection predicate

accessibilityPredicate - the predicate for test accessibility

Returns:

the operations in the class that satisfy the given predicates

operations

public static java.util.List<TypedOperation> operations(java.util.Collection<ClassOrInterfaceType> classTypes,
                                                        ReflectionPredicate reflectionPredicate,
                                                        AccessibilityPredicate accessibilityPredicate)

Returns the operations in the class that satisfy the given predicates.

Parameters:

classTypes - the declaring classes for collected operations

reflectionPredicate - the reflection predicate

accessibilityPredicate - the predicate for test accessibility

Returns:

the operations in the class that sastisfy the given predicates

operations

public static java.util.List<TypedOperation> operations(java.lang.Class<?> clazz,
                                                        ReflectionPredicate reflectionPredicate,
                                                        OmitMethodsPredicate omitPredicate,
                                                        AccessibilityPredicate accessibilityPredicate)

Returns the operations in the class that satisfy the given predicates.

Parameters:

clazz - the declaring class for collected operations

reflectionPredicate - the reflection predicate

omitPredicate - the list of Pattern objects for omitting methods, may be null

accessibilityPredicate - the predicate for test accessibility

Returns:

the operations in the class that sastisfy the given predicates

operations

public static java.util.List<TypedOperation> operations(ClassOrInterfaceType classType,
                                                        ReflectionPredicate reflectionPredicate,
                                                        OmitMethodsPredicate omitPredicate,
                                                        AccessibilityPredicate accessibilityPredicate)

Returns the operations in the class that satisfy the given predicates.

Parameters:

classType - the declaring class for collected operations

reflectionPredicate - the reflection predicate

omitPredicate - the list of Pattern objects for omitting methods, may be null

accessibilityPredicate - the predicate for test accessibility

Returns:

the operations in the class that sastisfy the given predicates

operations

public static java.util.List<TypedOperation> operations(java.util.Collection<ClassOrInterfaceType> classTypes,
                                                        ReflectionPredicate reflectionPredicate,
                                                        OmitMethodsPredicate omitPredicate,
                                                        AccessibilityPredicate accessibilityPredicate)

Returns the operations in the class that satisfy the given predicates.

Parameters:

classTypes - the declaring classes for collected operations

reflectionPredicate - the reflection predicate

omitPredicate - the list of Pattern objects for omitting methods, may be null

accessibilityPredicate - the predicate for test accessibility

Returns:

the operations in the class that sastisfy the given predicates

operations

public static java.util.List<TypedOperation> operations(java.lang.Class<?> clazz,
                                                        ReflectionPredicate reflectionPredicate,
                                                        OmitMethodsPredicate omitMethodsPredicate,
                                                        AccessibilityPredicate accessibilityPredicate,
                                                        SpecificationCollection operationSpecifications)

Returns the operations in the class that satisfy the given predicates.

Parameters:

clazz - the declaring class for collected operations

reflectionPredicate - the reflection predicate

omitMethodsPredicate - the list of Pattern objects for omitting methods, may be null

accessibilityPredicate - the predicate for test accessibility

operationSpecifications - the specifications (pre/post/throws-conditions)

Returns:

the operations in the class that sastisfy the given predicates

operations

public static java.util.List<TypedOperation> operations(ClassOrInterfaceType classType,
                                                        ReflectionPredicate reflectionPredicate,
                                                        OmitMethodsPredicate omitMethodsPredicate,
                                                        AccessibilityPredicate accessibilityPredicate,
                                                        SpecificationCollection operationSpecifications)

Returns the operations in the class that satisfy the given predicates.

Parameters:

classType - the declaring class for collected operations

reflectionPredicate - the reflection predicate

omitMethodsPredicate - the list of Pattern objects for omitting methods, may be null

accessibilityPredicate - the predicate for test accessibility

operationSpecifications - the specifications (pre/post/throws-conditions)

Returns:

the operations in the class that sastisfy the given predicates

operations

public static java.util.List<TypedOperation> operations(java.util.Collection<ClassOrInterfaceType> classTypes,
                                                        ReflectionPredicate reflectionPredicate,
                                                        OmitMethodsPredicate omitMethodsPredicate,
                                                        AccessibilityPredicate accessibilityPredicate,
                                                        SpecificationCollection operationSpecifications)

Returns the operations in the class that satisfy the given predicates.

Parameters:

classTypes - the declaring classes for collected operations

reflectionPredicate - the reflection predicate

omitMethodsPredicate - the list of Pattern objects for omitting methods, may be null

accessibilityPredicate - the predicate for test accessibility

operationSpecifications - the specifications (pre/post/throws-conditions)

Returns:

the operations in the class that sastisfy the given predicates

classListToTypeList

public static java.util.List<ClassOrInterfaceType> classListToTypeList(java.util.List<java.lang.Class<?>> classes)

Converts a list of classes to a list of ClassOrInterfaceType.

Parameters:

classes - a list of Class objects

Returns:

a list of ClassOrInterfaceType objects

instantiateTypes

private TypedClassOperation instantiateTypes(TypedClassOperation operation)

Updates the operation types in the case that operation.getDeclaringType() is generic, but classType is not. Constructs a Substitution that unifies the generic declaring type with classType or a superType.

Parameters:

operation - the operation to instantiate

Returns:

operation instantiated to match classType if the declaring type is generic and classType is not; the unmodified operation otherwise

Throws:

RandoopBug - if there is no substitution that unifies the declaring type with classType or a supertype

checkSubTypes

private void checkSubTypes(TypedClassOperation operation)

Ensures that field classType of this object is a subtype of operation.getDeclaringType(); throws an exception if not.

Parameters:

operation - the operation for which types are to be checked

Throws:

RandoopBug - if field classType of this is not a subtype of operation.getDeclaringType()

visit

public void visit(java.lang.reflect.Constructor<?> constructor)

Creates a ConstructorCall object for the Constructor.

Specified by:

visit in interface ClassVisitor

Overrides:

visit in class DefaultClassVisitor

Parameters:

constructor - a Constructor object to be represented as an Operation

visit

public void visit(java.lang.reflect.Method method)

Creates a MethodCall object for the Method.

The created operation has the declaring class of method as the declaring type. An exception is a static method for which the declaring class is not public, in which case classType is used as the declaring class.

Specified by:

visit in interface ClassVisitor

Overrides:

visit in class DefaultClassVisitor

Parameters:

method - a Method object to be represented as an Operation

visit

public void visit(java.lang.reflect.Field field)

Adds the Operation objects corresponding to getters and setters appropriate to the kind of field.

Specified by:

visit in interface ClassVisitor

Overrides:

visit in class DefaultClassVisitor

Parameters:

field - a Field object to be represented as an Operation

visit

public void visit(java.lang.Enum<?> e)

Creates a EnumConstant object for the Enum.

Specified by:

visit in interface ClassVisitor

Overrides:

visit in class DefaultClassVisitor

Parameters:

e - an Enum object to be represented as an Operation

getOperations

public java.util.Collection<TypedOperation> getOperations()

Returns the TypedOperation objects collected for classType.

Should be called after all members of the class are visited.

Returns:

the collection of operations collected for the class