org.xenei.junit.contract.filter

Class PrefixClassFilter

java.lang.Object

org.xenei.junit.contract.filter.AbstractBaseClassFilter

org.xenei.junit.contract.filter.AbstractStringClassFilter

org.xenei.junit.contract.filter.PrefixClassFilter

All Implemented Interfaces:

Serializable, ClassFilter

public class PrefixClassFilter
extends AbstractStringClassFilter
implements Serializable

A filter that matches classes by prefix.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.xenei.junit.contract.filter.ClassFilter

ClassFilter.Util

Field Summary

Fields inherited from class org.xenei.junit.contract.filter.AbstractStringClassFilter

caseSensitivity

Fields inherited from class org.xenei.junit.contract.filter.AbstractBaseClassFilter

NO_ARGS

Fields inherited from interface org.xenei.junit.contract.filter.ClassFilter

ABSTRACT, ANNOTATION, FALSE, INTERFACE, 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.

Methods inherited from class org.xenei.junit.contract.filter.AbstractStringClassFilter

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

Methods inherited from class org.xenei.junit.contract.filter.AbstractBaseClassFilter

filter, filterNames, funcName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

accept

public boolean accept(String className)

Checks to see if the filename starts with the prefix.

Specified by:

accept in interface ClassFilter

Parameters:

className - the class name to check.

Returns:

true if the filename starts with one of our prefixes