org.dessertj.matching

Class NamePattern

java.lang.Object

org.dessertj.matching.NamePattern

All Implemented Interfaces:

Comparable<NamePattern>

public class NamePattern
extends Object
implements Comparable<NamePattern>

This pattern identifies a set of classes by their full qualified classname. The syntax has been motivated by the AspectJ TypeNamePattern with slight modifications:

• The pattern can either be a plain type name, the wildcard *, or an identifier with embedded * or .. wildcards or the | separator
• An * matches any sequence of characters, but does not match the package separator "."
• An | separates alternatives that do not contain a package separator "."
• An .. matches any sequence of characters that starts and ends with the package separator "."
• The identifier to match with is always the name returned by Class.getName(). Thus $ is the only inner-type separator supported.
• The * does match $, too.
• A leading .. additionally matches the root package.

Examples:

Sample	Description
sample.Foo	Matches only sample.Foo
sample.Foo*	Matches all types in sample starting with "Foo" and all inner-types of Foo
sample.bar|baz.*	Matches all types in sample.bar and sample.baz
sample.Foo$*	Matches only inner-types of Foo
..Foo	Matches all Foo in any package (incl. root package)
*.*..Foo	Matches all Foo nested in a sub-package
*	Matches all types in the root package
..*	Matches all types

Field Summary

Fields

Modifier and Type	Field and Description
static NamePattern	ANY_NAME

Method Summary

Modifier and Type	Method and Description
int	compareTo(NamePattern other) Make sure name patterns are evaluated in the most useful order
boolean	isAllClasses()
boolean	isAny()
boolean	isMoreConcreteThan(NamePattern other) Use a heuristic to check whether this or the other name pattern should be evaluated first.
ShortNameMatcher	matcher()
boolean	matches(String name) Matches 'name' against the pattern.
static NamePattern	of(String pattern)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ANY_NAME

public static final NamePattern ANY_NAME

Method Detail

of

public static NamePattern of(String pattern)

isAny

public boolean isAny()

isAllClasses

public boolean isAllClasses()

matches

public boolean matches(String name)

Matches 'name' against the pattern.

Parameters:

name - the identifier to match

Returns:

true if the identifier matches

matcher

public ShortNameMatcher matcher()

Returns:

the first matcher to match the top-level package of the identifier

isMoreConcreteThan

public boolean isMoreConcreteThan(NamePattern other)

Use a heuristic to check whether this or the other name pattern should be evaluated first. The name pattern that produces the smallest number of matches is the best to evaluate first, because each match costs additional effort.

Parameters:

other - the other pattern

Returns:

true if this pattern should be evaluated first.

compareTo

public int compareTo(NamePattern other)

Make sure name patterns are evaluated in the most useful order

Specified by:

compareTo in interface Comparable<NamePattern>

Parameters:

other - the object to be compared.

Returns:

-1 if this name pattern is more concrete than the other one

toString

public String toString()

Overrides:

toString in class Object