org.xenei.junit.contract.filter

Class WildcardClassFilter

java.lang.Object

org.xenei.junit.contract.filter.AbstractBaseClassFilter

org.xenei.junit.contract.filter.WildcardClassFilter

All Implemented Interfaces:

Serializable, ClassFilter

public class WildcardClassFilter
extends AbstractBaseClassFilter
implements Serializable

Filters classes using the supplied wildcards.

This filter selects classes one or more wildcards. Testing is case-sensitive by default, but this can be configured.

The wildcard matcher uses the characters '?' and '*' to represent a single or multiple characters. This is the same as often found on Dos/Unix command lines.

For example:

 Class<?> clazz = org.xenei.junit.contract.filter.ClassFilter.class;
 ClassFilter filter = new WildcardClassFilter("*.filter.*");
 if (filter.accept(clazz)) {
        System.out.println("it works");
 }
 

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.AbstractBaseClassFilter

NO_ARGS

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

ABSTRACT, ANNOTATION, FALSE, INTERFACE, TRUE

Constructor Summary

Constructors

Constructor and Description
WildcardClassFilter(Case caseSensitivity, Collection<String> wildcards) Construct a new wildcard filter for a collection of wildcards specifying case-sensitivity.
WildcardClassFilter(Case caseSensitivity, String... wildcards) Construct a new wildcard filter for an array of wildcards specifying case-sensitivity.
WildcardClassFilter(Case caseSensitivity, String wildcard) Construct a new wildcard filter for a single wildcard specifying case-sensitivity.
WildcardClassFilter(Collection<String> wildcards) Construct a new case-sensitive wildcard filter for a collection of wildcards.
WildcardClassFilter(String... wildcards) Construct a new case-sensitive wildcard filter for an array of wildcards.
WildcardClassFilter(String wildcard) Construct a new case-sensitive wildcard filter for a single wildcard.

Method Summary

Modifier and Type	Method and Description
boolean	accept(Class<?> clazz) Accept a class.
boolean	accept(String className) Accept a class name.
void	addWildcard(String wildcard) Add a single wildcard string to the filter.
void	addWildCards(Collection<String> wildcards) Add a collection of wild card strings to the filter
void	addWildCards(String... wildcards) Add an array of wild card strings to the filter
String[]	args() Get the arguments for the function.
static String	makeRegex(String wildcard) Convert the wildcard string into a regex string.
String	toString() Provide a String representation of this file filter.

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

WildcardClassFilter

public WildcardClassFilter(String wildcard)

Construct a new case-sensitive wildcard filter for a single wildcard.

Parameters:

wildcard - the wildcard to match

Throws:

IllegalArgumentException - if the pattern is null

WildcardClassFilter

public WildcardClassFilter(Case caseSensitivity,
                           String wildcard)

Construct a new wildcard filter for a single wildcard specifying case-sensitivity.

Parameters:

wildcard - the wildcard to match, not null

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

Throws:

IllegalArgumentException - if the pattern is null

WildcardClassFilter

public WildcardClassFilter(String... wildcards)

Construct a new case-sensitive wildcard filter for an array of wildcards.

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

Parameters:

wildcards - the array of wildcards to match

Throws:

IllegalArgumentException - if the pattern array is null

WildcardClassFilter

public WildcardClassFilter(Case caseSensitivity,
                           String... wildcards)

Construct a new wildcard filter for an array of wildcards specifying case-sensitivity.

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

Parameters:

wildcards - the array of wildcards to match, not null

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

Throws:

IllegalArgumentException - if the pattern array is null

WildcardClassFilter

public WildcardClassFilter(Collection<String> wildcards)

Construct a new case-sensitive wildcard filter for a collection of wildcards.

Parameters:

wildcards - the list of wildcards to match, not null

Throws:

IllegalArgumentException - if the pattern list is null

ClassCastException - if the list does not contain Strings

WildcardClassFilter

public WildcardClassFilter(Case caseSensitivity,
                           Collection<String> wildcards)

Construct a new wildcard filter for a collection of wildcards specifying case-sensitivity.

Parameters:

wildcards - the list of wildcards to match, not null

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

Throws:

IllegalArgumentException - if the pattern list is null

ClassCastException - if the list does not contain Strings

Method Detail

addWildCards

public void addWildCards(Collection<String> wildcards)

Add a collection of wild card strings to the filter

Parameters:

wildcards - The list of wildcard strings.

Throws:

IllegalArgumentException - if the list is null or if any string within the list is null.

addWildCards

public void addWildCards(String... wildcards)

Add an array of wild card strings to the filter

Parameters:

wildcards - The array of wildcard strings.

Throws:

IllegalArgumentException - if the array is null or if any string within the list is null.

addWildcard

public void addWildcard(String wildcard)

Add a single wildcard string to the filter.

Parameters:

wildcard - the string to add.

Throws:

IllegalArgumentException - if the wildcard is null.

toString

public String toString()

Provide a String representation of this file filter.

Overrides:

toString in class AbstractBaseClassFilter

Returns:

a String representation

makeRegex

public static String makeRegex(String wildcard)

Convert the wildcard string into a regex string. Wildcards use '*' to denote multiple characters and '?' to denot a single character.

Parameters:

wildcard - The wild card string to convert.

Returns:

the corresponding regular expression string.

accept

public boolean accept(Class<?> clazz)

Accept a class.

Specified by:

accept in interface ClassFilter

Parameters:

clazz - the class to accept.

Returns:

True if the class matches the filter, false otherwise.

accept

public boolean accept(String className)

Accept a class name. In some cases this is a string compare in other cases the class is loaded from the class loader and other comparisons made.

Specified by:

accept in interface ClassFilter

Parameters:

className - the class name to accept.

Returns:

True if the class matches the filter, false otherwise.

args

public String[] args()

Get the arguments for the function.

Specified by:

args in interface ClassFilter

Returns:

the arguments for this function.