org.xenei.junit.contract.filter

Interface ClassFilter

All Known Subinterfaces:

ConditionalClassFilter

All Known Implementing Classes:

AbstractBaseClassFilter, AbstractClassFilter, AbstractConditionalClassFilter, AbstractStringClassFilter, AndClassFilter, AnnotationClassFilter, FalseClassFilter, HasAnnotationClassFilter, InterfaceClassFilter, NameClassFilter, NotClassFilter, OrClassFilter, PrefixClassFilter, RegexClassFilter, SuffixClassFilter, TrueClassFilter, WildcardClassFilter

public interface ClassFilter

Interface that defines a ClassFilter.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ClassFilter.Util A collection of utility functions of ClassFilters.

Field Summary

Fields

Modifier and Type	Field and Description
static ClassFilter	ABSTRACT The instance of the abstract() class filter.
static ClassFilter	ANNOTATION The instance of the annotation() class filter.
static ClassFilter	FALSE The instance of the false() class filter.
static ClassFilter	INTERFACE The instance of the interface() class filter.
static ClassFilter	TRUE The instance of the true() class filter.

Method Summary

Modifier and Type	Method and Description
boolean	accept(Class<?> clazz) Accept a class.
boolean	accept(String className) Accept a class name.
String[]	args() Get the arguments for the function.
Collection<Class<?>>	filter(Collection<Class<?>> collection) Filter the collection.
Collection<String>	filterNames(Collection<String> collection) Filter the collection.
String	funcName() Function name for the filter.

Field Detail

TRUE

static final ClassFilter TRUE

The instance of the true() class filter.

FALSE

static final ClassFilter FALSE

The instance of the false() class filter.

ANNOTATION

static final ClassFilter ANNOTATION

The instance of the annotation() class filter.

ABSTRACT

static final ClassFilter ABSTRACT

The instance of the abstract() class filter.

INTERFACE

static final ClassFilter INTERFACE

The instance of the interface() class filter.

Method Detail

accept

boolean accept(Class<?> clazz)

Accept a class.

Parameters:

clazz - the class to accept.

Returns:

True if the class matches the filter, false otherwise.

accept

boolean accept(String className)

Accept a class name. In some cases this is a string compare in other cases the class is loaded from the class loader and other comparisons made.

Parameters:

className - the class name to accept.

Returns:

True if the class matches the filter, false otherwise.

funcName

String funcName()

Function name for the filter. Used in parsing filter constructs from strings.

Returns:

The function name.

filter

Collection<Class<?>> filter(Collection<Class<?>> collection)

Filter the collection. Results will be returned in the order that the default iterator will return them from the collections parameter.

Parameters:

collection - the collection of classes to filter.

Returns:

The filtered collection

filterNames

Collection<String> filterNames(Collection<String> collection)

Filter the collection. Results will be returned in the order that the default iterator will return them from the collections parameter.

Parameters:

collection - the collection of class names to filter.

Returns:

The filtered collection

args

String[] args()

Get the arguments for the function.

Returns:

the arguments for this function.