org.xenei.classpathutils.filter

Class NameClassFilter

java.lang.Object

org.xenei.classpathutils.filter._AbstractBaseFilter

org.xenei.classpathutils.filter._AbstractStringFilter

org.xenei.classpathutils.filter.NameClassFilter

All Implemented Interfaces:

Serializable, ClassPathFilter, FilterType, StringFilterType

public class NameClassFilter
extends _AbstractStringFilter
implements Serializable

filters classes by name.

See Also:

Serialized Form

Nested Class Summary

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

ClassPathFilter.Util

Field Summary

Fields inherited from class org.xenei.classpathutils.filter._AbstractStringFilter

caseSensitivity

Fields inherited from class org.xenei.classpathutils.filter._AbstractBaseFilter

NO_ARGS

Fields inherited from interface org.xenei.classpathutils.ClassPathFilter

ABSTRACT_CLASS, ANNOTATION_CLASS, FALSE, INTERFACE_CLASS, TRUE

Constructor Summary

Constructors

Constructor and Description
NameClassFilter(Case caseSensitivity, Collection<String> names) Constructs a new name class filter for a collection of names specifying case-sensitivity.
NameClassFilter(Case caseSensitivity, String... names) Constructs a new name class filter for an array of names specifying case-sensitivity.
NameClassFilter(Case caseSensitivity, String name) Construct a new name class filter specifying case-sensitivity.
NameClassFilter(Collection<String> names) Constructs a new case-sensitive name class filter for a collection of names.
NameClassFilter(String... names) Constructs a new case-sensitive name class filter for an array of names.
NameClassFilter(String name) Constructs a new case-sensitive name class filter for a single name.

Method Summary

Modifier and Type	Method and Description
boolean	accept(String className) Checks to see if the name matches.
NameClassFilter	addClass(Class<?> clazz) Add a string to the filter.
NameClassFilter	addClasses(Class<?>... classes) Add an array of strings to the filter.
NameClassFilter	addClasses(Collection<Class<?>> classes) Add a collection of strings to the filter.
protected org.apache.commons.logging.Log	getLog()
ClassPathFilter	optimize()

Methods inherited from class org.xenei.classpathutils.filter._AbstractStringFilter

accept, accept, addString, addStrings, addStrings, args, getStrings, toString

Methods inherited from class org.xenei.classpathutils.filter._AbstractBaseFilter

equals, filterClasses, filterNames, filterURLs, funcName, hashCode, loadClass

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xenei.classpathutils.ClassPathFilter

filterClasses, filterNames, filterURLs, funcName

Constructor Detail

NameClassFilter

public NameClassFilter(String name)

Constructs a new case-sensitive name class filter for a single name.

Parameters:

name - the name to allow, must not be null

Throws:

IllegalArgumentException - if the name is null

NameClassFilter

public NameClassFilter(Case caseSensitivity,
                       String name)

Construct a new name class filter specifying case-sensitivity.

Parameters:

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

name - the name to allow, must not be null

Throws:

IllegalArgumentException - if the name is null

NameClassFilter

public NameClassFilter(String... names)

Constructs a new case-sensitive name class filter for an array of names.

The array is not cloned, so could be changed after constructing the instance. This would be inadvisable however.

Parameters:

names - the names to allow, must not be null

Throws:

IllegalArgumentException - if the names array is null

NameClassFilter

public NameClassFilter(Case caseSensitivity,
                       String... names)

Constructs a new name class filter for an array of names specifying case-sensitivity.

The array is not cloned, so could be changed after constructing the instance. This would be inadvisable however.

Parameters:

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

names - the names to allow, must not be null

Throws:

IllegalArgumentException - if the names array is null

NameClassFilter

public NameClassFilter(Collection<String> names)

Constructs a new case-sensitive name class filter for a collection of names.

Parameters:

names - the names to allow, must not be null

Throws:

IllegalArgumentException - if the name list is null

ClassCastException - if the list does not contain Strings

NameClassFilter

public NameClassFilter(Case caseSensitivity,
                       Collection<String> names)

Constructs a new name class filter for a collection of names specifying case-sensitivity.

Parameters:

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

names - the names to allow, must not be null

Throws:

IllegalArgumentException - if the name list is null

ClassCastException - if the list does not contain Strings

Method Detail

getLog

protected org.apache.commons.logging.Log getLog()

Specified by:

getLog in class _AbstractBaseFilter

accept

public boolean accept(String className)

Checks to see if the name matches.

Specified by:

accept in interface ClassPathFilter

Parameters:

className - the class name to check

Returns:

true if the filename matches

addClass

public NameClassFilter addClass(Class<?> clazz)

Add a string to the filter.

Parameters:

str - the string to add.

Returns:

this for chaining.

addClasses

public final NameClassFilter addClasses(Collection<Class<?>> classes)

Add a collection of strings to the filter. Strings will be added in the order the collection iterator returns them.

Parameters:

strings - the collection of strings to be added.

addClasses

public final NameClassFilter addClasses(Class<?>... classes)

Add an array of strings to the filter.

Parameters:

strings - The strings to add.

Returns:

this for chaining

optimize

public ClassPathFilter optimize()

Specified by:

optimize in interface ClassPathFilter