org.xenei.classpathutils.filter

Class PrefixClassFilter

java.lang.Object

org.xenei.classpathutils.filter._AbstractBaseFilter

org.xenei.classpathutils.filter._AbstractStringFilter

org.xenei.classpathutils.filter.PrefixClassFilter

All Implemented Interfaces:

Serializable, ClassPathFilter, FilterType, StringFilterType

public class PrefixClassFilter
extends _AbstractStringFilter
implements Serializable

A filter that matches classes by prefix.

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
PrefixClassFilter(Case caseSensitivity, Collection<String> prefixes) Constructs a new Prefix class filter for a collection of prefixes specifying case-sensitivity.
PrefixClassFilter(Case caseSensitivity, String... prefixes) Constructs a new Prefix class filter for any of an array of prefixes specifying case-sensitivity.
PrefixClassFilter(Case caseSensitivity, String prefix) Constructs a new Prefix class filter for a single prefix specifying case-sensitivity.
PrefixClassFilter(List<String> prefixes) Constructs a new Prefix class filter for a list of prefixes.
PrefixClassFilter(String... prefixes) Constructs a new Prefix class filter for any of an array of prefixes.
PrefixClassFilter(String prefix) Constructs a new Prefix class filter for a single prefix.

Method Summary

Modifier and Type	Method and Description
boolean	accept(String className) Checks to see if the filename starts with the prefix.
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

PrefixClassFilter

public PrefixClassFilter(String prefix)

Constructs a new Prefix class filter for a single prefix.

Parameters:

prefix - the prefix to allow, must not be null

Throws:

IllegalArgumentException - if the prefix is null

PrefixClassFilter

public PrefixClassFilter(Case caseSensitivity,
                         String prefix)

Constructs a new Prefix class filter for a single prefix specifying case-sensitivity.

Parameters:

prefix - the prefix to allow, must not be null

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

PrefixClassFilter

public PrefixClassFilter(String... prefixes)

Constructs a new Prefix class filter for any of an array of prefixes.

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

Parameters:

prefixes - the prefixes to allow, must not be null

Throws:

IllegalArgumentException - if the prefix array is null

PrefixClassFilter

public PrefixClassFilter(Case caseSensitivity,
                         String... prefixes)

Constructs a new Prefix class filter for any of an array of prefixes specifying case-sensitivity.

The array is cloned.

Parameters:

prefixes - the prefixes to allow, must not be null

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

PrefixClassFilter

public PrefixClassFilter(List<String> prefixes)

Constructs a new Prefix class filter for a list of prefixes.

Parameters:

prefixes - the prefixes to allow, must not be null

Throws:

IllegalArgumentException - if the prefix list is null

ClassCastException - if the list does not contain Strings

PrefixClassFilter

public PrefixClassFilter(Case caseSensitivity,
                         Collection<String> prefixes)

Constructs a new Prefix class filter for a collection of prefixes specifying case-sensitivity.

Parameters:

prefixes - the prefixes to allow, must not be null

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

Throws:

IllegalArgumentException - if the prefix 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 filename starts with the prefix.

Specified by:

accept in interface ClassPathFilter

Parameters:

className - the class name to check.

Returns:

true if the filename starts with one of our prefixes

optimize

public ClassPathFilter optimize()

Specified by:

optimize in interface ClassPathFilter