net.sf.corn.cps

Class ClassFilter

java.lang.Object

net.sf.corn.cps.ClassFilter

All Implemented Interfaces:

CPResourceFilter

public class ClassFilter
extends Object
implements CPResourceFilter

This class is intended to be used as a filter for class typed resources to be used with CPScanner. It contains multiple filtering methods such as class types, class name and so on.

Author:

serhat.dirik

Constructor Summary

Constructors

Constructor and Description
ClassFilter()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	accept(Object subject) Tells whether the given subject is accepted or not.
ClassFilter	allTypes() Resets all type filtering options and accepts all classes
ClassFilter	annotationOnly() Filters annotations only and erases the other type options
ClassFilter	appendAnnotation(Class<? extends Annotation> annotation) Appends the given annotation to set of annotations to control scanned classes.
ClassFilter	appendClassName(String name) Adds a class name to this filter.
ClassFilter	appendInterface(Class<?> interfaceClass) Appends the given interface to set of interfaces to control scanned classes.
ClassFilter	appendSuperClass(Class<?> superClass) Appends the given class to set of super classes.
ClassFilter	classOnly() Filters classes only and erases the other type options
ClassFilter	enumOnly() Filters enums only and erases the other type options
boolean	filterable(Object subject) Tells if the given subject is filterable by this interface
ClassFilter	interfaceOnly() Filters interfaces only and erases the other type options
boolean	isAnnotationOnly() tells if the annotation only option is set
boolean	isClassOnly() tells if the class only option is set
boolean	isEnumOnly() tells if the enum only option is set
boolean	isInterfaceOnly() tells if the interface only option is set
ClassFilter	joinAnnotationsWithAnd() Changes the join behavior of annotations.
ClassFilter	joinAnnotationsWithOr() Changes the join behavior of annotations.
ClassFilter	joinInterfacesWithAnd() Changes the join behavior of interfaces.
ClassFilter	joinInterfacesWithOr() Changes the join behavior of interfaces.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassFilter

public ClassFilter()

Method Detail

accept

public boolean accept(Object subject)

Description copied from interface: CPResourceFilter

Tells whether the given subject is accepted or not. It always returns true if the given subject is not filterable

Specified by:

accept in interface CPResourceFilter

Parameters:

subject - parameter to check

Returns:

true if accepted

filterable

public boolean filterable(Object subject)

Description copied from interface: CPResourceFilter

Tells if the given subject is filterable by this interface

Specified by:

filterable in interface CPResourceFilter

Returns:

true if the given subject is target to this filter

appendClassName

public ClassFilter appendClassName(String name)

Adds a class name to this filter. The star ('*') character can be used with the names

Parameters:

name - class name

Returns:

this

appendAnnotation

public ClassFilter appendAnnotation(Class<? extends Annotation> annotation)

Appends the given annotation to set of annotations to control scanned classes. The default behavior of this filter, joins all annotations with logical 'or' operator which means that any class that any given annotation presented will be accepted by this filter.If you need filter classes that all annotations are presented, you need to call joinAnnotationsWithAnd().

Parameters:

annotation - that to be added to this filter

Returns:

this

appendInterface

public ClassFilter appendInterface(Class<?> interfaceClass)

Appends the given interface to set of interfaces to control scanned classes. The default behavior of this filter, joins all annotations with logical 'or' operator which means that any class that any given interface implemented will be accepted by this filter.If you need to filter classes that all interfaces are implemented, you need to call joinInterfacesWithAnd().

Parameters:

interfaceClass - that to be added to this filter

Returns:

this

appendSuperClass

public ClassFilter appendSuperClass(Class<?> superClass)

Appends the given class to set of super classes. Scanned classes will be filtered out by this filter if any one of the given super classes extended

Parameters:

superClass - class to be added to set of super classes

Returns:

this

joinAnnotationsWithOr

public ClassFilter joinAnnotationsWithOr()

Changes the join behavior of annotations. This is the default behavior

Returns:

this

joinInterfacesWithOr

public ClassFilter joinInterfacesWithOr()

Changes the join behavior of interfaces. This is the default behavior

Returns:

this

joinAnnotationsWithAnd

public ClassFilter joinAnnotationsWithAnd()

Changes the join behavior of annotations.

Returns:

this

joinInterfacesWithAnd

public ClassFilter joinInterfacesWithAnd()

Changes the join behavior of interfaces.

Returns:

this

allTypes

public ClassFilter allTypes()

Resets all type filtering options and accepts all classes

Returns:

this

interfaceOnly

public ClassFilter interfaceOnly()

Filters interfaces only and erases the other type options

Returns:

this

annotationOnly

public ClassFilter annotationOnly()

Filters annotations only and erases the other type options

Returns:

this

enumOnly

public ClassFilter enumOnly()

Filters enums only and erases the other type options

Returns:

this

classOnly

public ClassFilter classOnly()

Filters classes only and erases the other type options

Returns:

this

isInterfaceOnly

public boolean isInterfaceOnly()

tells if the interface only option is set

isAnnotationOnly

public boolean isAnnotationOnly()

tells if the annotation only option is set

isEnumOnly

public boolean isEnumOnly()

tells if the enum only option is set

isClassOnly

public boolean isClassOnly()

tells if the class only option is set