org.xenei.classpathutils.filter

Class SuffixClassFilter

java.lang.Object

org.xenei.classpathutils.filter._AbstractBaseFilter

org.xenei.classpathutils.filter._AbstractStringFilter

org.xenei.classpathutils.filter.SuffixClassFilter

All Implemented Interfaces:

Serializable, ClassPathFilter, FilterType, StringFilterType

public class SuffixClassFilter
extends _AbstractStringFilter
implements Serializable

A filter to match the suffix of a class 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
SuffixClassFilter(Case caseSensitivity, Collection<String> suffixes) Constructs a new Suffix class filter for a collection of suffixes specifying case-sensitivity.
SuffixClassFilter(Case caseSensitivity, String... suffixes) Constructs a new Suffix class filter for an array of suffixs specifying case-sensitivity.
SuffixClassFilter(Case caseSensitivity, String suffix) Constructs a new Suffix class filter for a single extension specifying case-sensitivity.
SuffixClassFilter(Collection<String> suffixes) Constructs a new Suffix file filter for a collection of suffixes.
SuffixClassFilter(String... suffixes) Constructs a new Suffix class filter for an array of suffixs.
SuffixClassFilter(String suffix) Constructs a new Suffix class filter for a single extension.

Method Summary

Modifier and Type	Method and Description
boolean	accept(String className) Checks to see if the class name ends with the suffix.
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

SuffixClassFilter

public SuffixClassFilter(String suffix)

Constructs a new Suffix class filter for a single extension.

Parameters:

suffix - the suffix to allow, must not be null

Throws:

IllegalArgumentException - if the suffix is null

SuffixClassFilter

public SuffixClassFilter(Case caseSensitivity,
                         String suffix)

Constructs a new Suffix class filter for a single extension specifying case-sensitivity.

Parameters:

suffix - the suffix to allow, must not be null

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

SuffixClassFilter

public SuffixClassFilter(String... suffixes)

Constructs a new Suffix class filter for an array of suffixs.

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

Parameters:

suffixes - the suffixes to allow, must not be null

Throws:

IllegalArgumentException - if the suffix array is null

SuffixClassFilter

public SuffixClassFilter(Case caseSensitivity,
                         String... suffixes)

Constructs a new Suffix class filter for an array of suffixs specifying case-sensitivity.

Parameters:

suffixes - the suffixes to allow, must not be null

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

Throws:

IllegalArgumentException - if the suffix array is null

SuffixClassFilter

public SuffixClassFilter(Collection<String> suffixes)

Constructs a new Suffix file filter for a collection of suffixes.

Parameters:

suffixes - the suffixes to allow, must not be null

Throws:

IllegalArgumentException - if the suffix list is null

ClassCastException - if the list does not contain Strings

SuffixClassFilter

public SuffixClassFilter(Case caseSensitivity,
                         Collection<String> suffixes)

Constructs a new Suffix class filter for a collection of suffixes specifying case-sensitivity.

Parameters:

suffixes - the suffixes to allow, must not be null

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

Throws:

IllegalArgumentException - if the suffix list is null

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 class name ends with the suffix.

Specified by:

accept in interface ClassPathFilter

Parameters:

className - the class name to check

Returns:

true if the filename ends with one of our suffixes

optimize

public ClassPathFilter optimize()

Specified by:

optimize in interface ClassPathFilter