org.xenei.junit.contract.filter

Class AbstractStringClassFilter

java.lang.Object

org.xenei.junit.contract.filter.AbstractBaseClassFilter

org.xenei.junit.contract.filter.AbstractStringClassFilter

All Implemented Interfaces:

ClassFilter

Direct Known Subclasses:

NameClassFilter, PrefixClassFilter, SuffixClassFilter

public abstract class AbstractStringClassFilter
extends AbstractBaseClassFilter

Base String filter, that converts class to class name for accept evaluation.

Nested Class Summary

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

ClassFilter.Util

Field Summary

Fields

Modifier and Type	Field and Description
protected Case	caseSensitivity Whether the comparison is case sensitive.

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

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

Method Summary

Modifier and Type	Method and Description
boolean	accept(Class<?> clazz) Converts class to name and calls accept( className )
void	addString(String str) Add a string to the filter.
void	addStrings(Collection<String> strings) Add a collection of strings to the filter.
void	addStrings(String... strings) Add an array of strings to the filter.
String[]	args() Get the arguments for the function.
List<String>	getStrings() Get the list of strings from the filter.
String	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

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

accept

Field Detail

caseSensitivity

protected final Case caseSensitivity

Whether the comparison is case sensitive.

Constructor Detail

AbstractStringClassFilter

protected AbstractStringClassFilter(String str)

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

Parameters:

str - the string to allow, must not be null

Throws:

IllegalArgumentException - if the str is null

AbstractStringClassFilter

protected AbstractStringClassFilter(Case caseSensitivity,
                                    String str)

Construct a new name class filter specifying case-sensitivity.

Parameters:

str - the string to allow, must not be null

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

Throws:

IllegalArgumentException - if the name is null

AbstractStringClassFilter

protected AbstractStringClassFilter(String... strings)

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:

strings - the array of strings to allow, must not be null or zero length

Throws:

IllegalArgumentException - if the names array is null

AbstractStringClassFilter

protected AbstractStringClassFilter(Case caseSensitivity,
                                    String... strings)

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

strings - the array of strings to allow, must not be null or zero length

Throws:

IllegalArgumentException - if the names array is null

AbstractStringClassFilter

protected AbstractStringClassFilter(Collection<String> strings)

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

Parameters:

strings - the array of strings to allow, must not be null or zero length

Throws:

IllegalArgumentException - if the name list is null

ClassCastException - if the list does not contain Strings

AbstractStringClassFilter

protected AbstractStringClassFilter(Case caseSensitivity,
                                    Collection<String> strings)

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

strings - the strings to check against.

Throws:

IllegalArgumentException - if the name list is null

ClassCastException - if the list does not contain Strings

Method Detail

args

public String[] args()

Get the arguments for the function.

Returns:

the arguments for this function.

addString

public final void addString(String str)

Add a string to the filter.

Parameters:

str - the string to add.

addStrings

public final void addStrings(Collection<String> strings)

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.

addStrings

public final void addStrings(String... strings)

Add an array of strings to the filter.

Parameters:

strings - The strings to add.

getStrings

public final List<String> getStrings()

Get the list of strings from the filter.

Returns:

An unmodifiableList of strings.

accept

public boolean accept(Class<?> clazz)

Converts class to name and calls accept( className )

Parameters:

clazz - the class to accept.

Returns:

true if the class name passes the filter.

toString

public String toString()

Overrides:

toString in class AbstractBaseClassFilter