uk.co.jemos.podam.api

Class AbstractClassInfoStrategy

java.lang.Object

uk.co.jemos.podam.api.AbstractClassInfoStrategy

All Implemented Interfaces:

ClassAttributeApprover, ClassInfoStrategy

Direct Known Subclasses:

DefaultClassInfoStrategy

public abstract class AbstractClassInfoStrategy
extends Object
implements ClassInfoStrategy, ClassAttributeApprover

Default abstract implementation of a ClassInfoStrategy

This default implementation is based on field introspection.

Since:

5.1.0

Author:

daivanov

Field Summary

Fields

Modifier and Type	Field and Description
private Set<Class<? extends Annotation>>	excludedAnnotations Set of annotations, which mark fields to be skipped from populating.
private Map<Class<?>,Set<String>>	excludedFields Set of fields, which mark fields to be skipped from populating.
private Map<Class<?>,List<Method>>	extraMethods Set of extra methods to execute.

Constructor Summary

Constructors

Constructor and Description
AbstractClassInfoStrategy()

Method Summary

Modifier and Type	Method and Description
AbstractClassInfoStrategy	addExcludedAnnotation(Class<? extends Annotation> annotation) Adds the specified Annotation to set of excluded annotations, if it is not already present.
AbstractClassInfoStrategy	addExcludedField(Class<?> pojoClass, String fieldName) Adds the specified field to set of excluded fields, if it is not already present.
AbstractClassInfoStrategy	addExtraMethod(Class<?> pojoClass, String methodName, Class<?>... methodArgs) It adds an extra method to execute
boolean	approve(ClassAttribute attribute) Override this method to select or reject class attributes
ClassAttributeApprover	getClassAttributeApprover(Class<?> pojoClass)
ClassInfo	getClassInfo(Class<?> pojoClass)
Set<Class<? extends Annotation>>	getExcludedAnnotations() Identifies Annotations for fields to be skipped.
Set<String>	getExcludedFields(Class<?> pojoClass) Identifies fields to be skipped.
Collection<Method>	getExtraMethods(Class<?> pojoClass) It returns the collection of extra methods to execute.
AbstractClassInfoStrategy	removeExcludedAnnotation(Class<? extends Annotation> annotation) Removes the specified Annotation from set of excluded annotations.
AbstractClassInfoStrategy	removeExcludedField(Class<?> pojoClass, String fieldName) Removes the field name from set of excluded fields.

Methods inherited from class java.lang.Object

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

Field Detail

excludedAnnotations

private final Set<Class<? extends Annotation>> excludedAnnotations

Set of annotations, which mark fields to be skipped from populating.

excludedFields

private Map<Class<?>,Set<String>> excludedFields

Set of fields, which mark fields to be skipped from populating.

extraMethods

private final Map<Class<?>,List<Method>> extraMethods

Set of extra methods to execute.

Since:

5.3.0

Constructor Detail

AbstractClassInfoStrategy

public AbstractClassInfoStrategy()

Method Detail

addExcludedAnnotation

public AbstractClassInfoStrategy addExcludedAnnotation(Class<? extends Annotation> annotation)

Adds the specified Annotation to set of excluded annotations, if it is not already present.

Parameters:

annotation - the annotation to use as an exclusion mark

Returns:

itself

addExtraMethod

public AbstractClassInfoStrategy addExtraMethod(Class<?> pojoClass,
                                                String methodName,
                                                Class<?>... methodArgs)
                                         throws NoSuchMethodException,
                                                SecurityException

It adds an extra method to execute

Parameters:

pojoClass - The pojo class where to execute the method

methodName - name to be scheduled for execution

methodArgs - list of method arguments

Returns:

this object

Throws:

SecurityException - If a security exception occurred while retrieving the method

NoSuchMethodException - If pojoClass doesn't declare the required method

Since:

5.3.0

removeExcludedAnnotation

public AbstractClassInfoStrategy removeExcludedAnnotation(Class<? extends Annotation> annotation)

Removes the specified Annotation from set of excluded annotations.

Parameters:

annotation - the annotation used as an exclusion mark

Returns:

itself

addExcludedField

public AbstractClassInfoStrategy addExcludedField(Class<?> pojoClass,
                                                  String fieldName)

Adds the specified field to set of excluded fields, if it is not already present.

Parameters:

pojoClass - a class for which fields should be skipped

fieldName - the field name to use as an exclusion mark

Returns:

itself

removeExcludedField

public AbstractClassInfoStrategy removeExcludedField(Class<?> pojoClass,
                                                     String fieldName)

Removes the field name from set of excluded fields.

Parameters:

pojoClass - a class for which fields should be skipped

fieldName - the field name used as an exlusion mark

Returns:

itself

approve

public boolean approve(ClassAttribute attribute)

Override this method to select or reject class attributes

Specified by:

approve in interface ClassAttributeApprover

Parameters:

attribute - class attribute to analyze for further processing or skipping

Returns:

true, if attribute should be kept, false, if it should be skipped

getExcludedAnnotations

public Set<Class<? extends Annotation>> getExcludedAnnotations()

Identifies Annotations for fields to be skipped.

Should return set of annotations, which will be treated as notion for PodamFactory to skip production of these particular fields.

Specified by:

getExcludedAnnotations in interface ClassInfoStrategy

Returns:

set of annotations, which mark fields to be skipped from populating.

getExcludedFields

public Set<String> getExcludedFields(Class<?> pojoClass)

Identifies fields to be skipped.

Should return set of field names as case-sensitive string, which will be treated as notion for PodamFactory to skip production of these particular fields.

Specified by:

getExcludedFields in interface ClassInfoStrategy

Parameters:

pojoClass - a class for which fields should be skipped

Returns:

set of field name, which mark fields to be skipped from populating.

getClassInfo

public ClassInfo getClassInfo(Class<?> pojoClass)

Specified by:

getClassInfo in interface ClassInfoStrategy

Parameters:

pojoClass - a class to introspect and fetch attributes

Returns:

information about class internal structure ClassInfo

getClassAttributeApprover

public ClassAttributeApprover getClassAttributeApprover(Class<?> pojoClass)

Specified by:

getClassAttributeApprover in interface ClassInfoStrategy

getExtraMethods

public Collection<Method> getExtraMethods(Class<?> pojoClass)

Description copied from interface: ClassInfoStrategy

It returns the collection of extra methods to execute.

Specified by:

getExtraMethods in interface ClassInfoStrategy

Parameters:

pojoClass - The pojo class

Returns:

the collection of extra methods to execute.