org.xenei.classpathutils

Interface ClassPathFilter

All Known Subinterfaces:

ClassFilterType, CollectionFilterType, FilterType, LogicFilterType, StringFilterType

All Known Implementing Classes:

_AbstractBaseFilter, _AbstractConditionalFilter, _AbstractStringFilter, AbstractClassFilter, AndClassFilter, AnnotationClassFilter, FalseClassFilter, HasAnnotationClassFilter, InterfaceClassFilter, NameClassFilter, NotClassFilter, OrClassFilter, PrefixClassFilter, RegexClassFilter, SuffixClassFilter, TrueClassFilter, WildcardClassFilter

public interface ClassPathFilter

Interface that defines a ClassFilter.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static ClassPathFilter	ABSTRACT_CLASS The instance of the abstract() class filter.
static ClassPathFilter	ANNOTATION_CLASS The instance of the annotation() class filter.
static ClassPathFilter	FALSE The instance of the false() class filter.
static ClassPathFilter	INTERFACE_CLASS The instance of the interface() class filter.
static ClassPathFilter	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.
boolean	accept(URL url) Accept a URL.
String[]	args() Get the arguments for the function.
Collection<Class<?>>	filterClasses(Collection<Class<?>> collection) Filter the collection.
Collection<String>	filterNames(Collection<String> collection) Filter the collection.
Collection<URL>	filterURLs(Collection<URL> collection) Filter the collection.
String	funcName() Function name for the filter.
ClassPathFilter	optimize()

Field Detail

TRUE

static final ClassPathFilter TRUE

The instance of the true() class filter.

FALSE

static final ClassPathFilter FALSE

The instance of the false() class filter.

ANNOTATION_CLASS

static final ClassPathFilter ANNOTATION_CLASS

The instance of the annotation() class filter.

ABSTRACT_CLASS

static final ClassPathFilter ABSTRACT_CLASS

The instance of the abstract() class filter.

INTERFACE_CLASS

static final ClassPathFilter INTERFACE_CLASS

The instance of the interface() class filter.

Method Detail

optimize

ClassPathFilter optimize()

accept

boolean accept(URL url)

Accept a URL.

Parameters:

url - the url 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.

accept

boolean accept(Class<?> clazz)

Accept a Class.

Parameters:

clazz - the clazz 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.

filterURLs

Collection<URL> filterURLs(Collection<URL> 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

filterClasses

Collection<Class<?>> filterClasses(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

args

String[] args()

Get the arguments for the function.

Returns:

the arguments for this function.