org.xenei.classpathutils.filter

Class RegexClassFilter

java.lang.Object

org.xenei.classpathutils.filter.RegexClassFilter

All Implemented Interfaces:

Serializable, ClassPathFilter, FilterType, StringFilterType

public class RegexClassFilter
extends Object
implements ClassPathFilter, Serializable, StringFilterType

Match classes with a regular expression.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.xenei.classpathutils.ClassPathFilter

ClassPathFilter.Util

Field Summary

Fields inherited from interface org.xenei.classpathutils.ClassPathFilter

ABSTRACT_CLASS, ANNOTATION_CLASS, FALSE, INTERFACE_CLASS, TRUE

Constructor Summary

Constructors

Constructor and Description
RegexClassFilter(Case caseSensitivity, String pattern) Construct a new regular expression filter with the specified flags case sensitivity.
RegexClassFilter(Pattern pattern) Construct a new regular expression filter for a compiled regular expression
RegexClassFilter(String pattern) Construct a new regular expression filter.
RegexClassFilter(String pattern, int flags) Construct a new regular expression filter with the specified flags.

Method Summary

Modifier and Type	Method and Description
boolean	accept(Class<?> clazz) Converts class to name and calls accept( className )
boolean	accept(String className) Checks to see if the class name matches the regular expression.
boolean	accept(URL url) Checks to see if the URL name matches the regular expression.
String[]	args() Get the arguments for the function.
boolean	equals(Object o)
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.
int	hashCode()
ClassPathFilter	optimize()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RegexClassFilter

public RegexClassFilter(String pattern)

Construct a new regular expression filter.

Parameters:

pattern - regular string expression to match

Throws:

IllegalArgumentException - if the pattern is null

RegexClassFilter

public RegexClassFilter(Case caseSensitivity,
                        String pattern)

Construct a new regular expression filter with the specified flags case sensitivity.

Parameters:

pattern - regular string expression to match

caseSensitivity - how to handle case sensitivity, null means case-sensitive

Throws:

IllegalArgumentException - if the pattern is null

RegexClassFilter

public RegexClassFilter(String pattern,
                        int flags)

Construct a new regular expression filter with the specified flags.

Parameters:

pattern - regular string expression to match

flags - pattern flags - e.g. Pattern.CASE_INSENSITIVE

Throws:

IllegalArgumentException - if the pattern is null

RegexClassFilter

public RegexClassFilter(Pattern pattern)

Construct a new regular expression filter for a compiled regular expression

Parameters:

pattern - regular expression to match

Throws:

IllegalArgumentException - if the pattern is null

Method Detail

funcName

public String funcName()

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

Specified by:

funcName in interface ClassPathFilter

Returns:

The function name.

accept

public boolean accept(String className)

Checks to see if the class name matches the regular expression.

Specified by:

accept in interface ClassPathFilter

Parameters:

className - the class name to match

Returns:

true if the filename matches one of the regular expressions

accept

public boolean accept(URL url)

Checks to see if the URL name matches the regular expression.

Specified by:

accept in interface ClassPathFilter

Parameters:

url - the URL to match

Returns:

true if the filename matches one of the regular expressions

accept

public boolean accept(Class<?> clazz)

Converts class to name and calls accept( className )

Specified by:

accept in interface ClassPathFilter

Parameters:

clazz - the clazz to accept.

Returns:

true if the class name passes the filter.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

args

public String[] args()

Get the arguments for the function.

Specified by:

args in interface ClassPathFilter

Returns:

the arguments for this function.

filterURLs

public 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.

Specified by:

filterURLs in interface ClassPathFilter

Parameters:

collection - the collection of classes to filter.

Returns:

The filtered collection

filterNames

public 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.

Specified by:

filterNames in interface ClassPathFilter

Parameters:

collection - the collection of class names to filter.

Returns:

The filtered collection

filterClasses

public 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.

Specified by:

filterClasses in interface ClassPathFilter

Parameters:

collection - the collection of classes to filter.

Returns:

The filtered collection

optimize

public ClassPathFilter optimize()

Specified by:

optimize in interface ClassPathFilter