org.refcodes.matcher.impls

Class PathMatcherImpl

java.lang.Object

org.refcodes.matcher.impls.PathMatcherImpl

All Implemented Interfaces:

Matcher<String>, PathMatcher

public class PathMatcherImpl
extends Object
implements PathMatcher

Implements the PathMatcher interface.

Constructor Summary

Constructors

Constructor and Description
PathMatcherImpl(String aPathPattern) Constructs an ANT Path Matcher, matching its ANT path pattern against the path provided to the isMatching(String) method.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getPathPattern() Returns the path pattern being used by the PathMatcher.
String[]	getWildcardNames() Retrieves the list of wildcard names identifying the wildcards as specified by the path pattern.
int	hashCode()
boolean	isMatching(String aPath) The this method applies the following rules from the configured ANT path pattern to the path provided via PathMatcher.isMatching(String) method: A single asterisk ("*") matches zero or more characters within a path name.
String	toPattern() For debugging purposes, retrieve the regex pattern created from the ANT path pattern.
String	toWildcardReplacement(String aPath, String aWildcardName) Returns the wildcard substitute for the wildcards in your path pattern (see PathMatcher.getPathPattern()) compared to the actual path (as of PathMatcher.toWildcardSubstitutes(String)).
String	toWildcardReplacementAt(String aPath, int aIndex) Returns the wildcard substitute for the wildcards in your path pattern (see PathMatcher.getPathPattern()) compared to the actual path (as of PathMatcher.toWildcardSubstitutes(String)).
String[]	toWildcardReplacements(String aPath) Returns an array of the wildcard substitutes for the wildcards in your path pattern (see PathMatcher.getPathPattern()) compared to the actual path (as of PathMatcher.toWildcardSubstitutes(String)).
String[]	toWildcardReplacements(String aPath, String... aWildcardNames) Returns the wildcard substitutes for the wildcards in your path pattern (see PathMatcher.getPathPattern()) compared to the actual path (as of PathMatcher.toWildcardSubstitutes(String)).
String[]	toWildcardReplacementsAt(String aPath, int... aIndexes) Returns the wildcard substitutes for the wildcards in your path pattern (see PathMatcher.getPathPattern()) compared to the actual path (as of PathMatcher.toWildcardSubstitutes(String)).
WildcardSubstitutes	toWildcardSubstitutes(String aPath) Returns all available wildcard substitutes as well as the named wildcard substitutes.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PathMatcherImpl

public PathMatcherImpl(String aPathPattern)

Constructs an ANT Path Matcher, matching its ANT path pattern against the path provided to the isMatching(String) method. The Delimiter.PATH_DELIMITER is used as default path delimiter. The PathMatcherImpl applies the following rules from the ANT path pattern to the path provided via isMatching(String) method: A single asterisk ("*") matches zero or more characters within a path name. A double asterisk ("**") matches zero or more characters across directory levels. A question mark ("?") matches exactly one character within a path name.

Parameters:

aPathPattern - The pattern to be used when matching a path via isMatching(String).

Method Detail

getWildcardNames

public String[] getWildcardNames()

Description copied from interface: PathMatcher

Retrieves the list of wildcard names identifying the wildcards as specified by the path pattern.

Specified by:

getWildcardNames in interface PathMatcher

Returns:

The wild card names or null of no wild card names have been defined.

getPathPattern

public String getPathPattern()

Description copied from interface: PathMatcher

Returns the path pattern being used by the PathMatcher.

Specified by:

getPathPattern in interface PathMatcher

Returns:

The path pattern being used.

isMatching

public boolean isMatching(String aPath)

Description copied from interface: PathMatcher

The this method applies the following rules from the configured ANT path pattern to the path provided via PathMatcher.isMatching(String) method: A single asterisk ("*") matches zero or more characters within a path name. A double asterisk ("**") matches zero or more characters across directory levels. A question mark ("?") matches exactly one character within a path name

Specified by:

isMatching in interface Matcher<String>

Specified by:

isMatching in interface PathMatcher

Parameters:

aPath - The matchee used for testing matchability.

Returns:

True in case the matchee matches the matcher's criteria, else false.

toWildcardSubstitutes

public WildcardSubstitutes toWildcardSubstitutes(String aPath)

Description copied from interface: PathMatcher

Returns all available wildcard substitutes as well as the named wildcard substitutes.

Specified by:

toWildcardSubstitutes in interface PathMatcher

Parameters:

aPath - The path for which to retrieve the wildcard substitutes.

Returns:

The WildcardSubstitutes of the wildcards being substituted.

toWildcardReplacements

public String[] toWildcardReplacements(String aPath)

Description copied from interface: PathMatcher

Returns an array of the wildcard substitutes for the wildcards in your path pattern (see PathMatcher.getPathPattern()) compared to the actual path (as of PathMatcher.toWildcardSubstitutes(String)). The order of the wildcard substitutes aligns to the order of the wildcards (from left to right) defined in your path pattern.

Specified by:

toWildcardReplacements in interface PathMatcher

Parameters:

aPath - The path for which to retrieve the wildcard substitutes.

Returns:

The text substituting the wildcards in the order of the wildcards being substituted or null if there are none such substitutes.

toWildcardReplacementAt

public String toWildcardReplacementAt(String aPath,
                                      int aIndex)

Description copied from interface: PathMatcher

Returns the wildcard substitute for the wildcards in your path pattern (see PathMatcher.getPathPattern()) compared to the actual path (as of PathMatcher.toWildcardSubstitutes(String)). The text of the wildcard substitute aligns to the index of the wildcard (from left to right) as defined in your path pattern.

Specified by:

toWildcardReplacementAt in interface PathMatcher

Parameters:

aPath - The path for which to retrieve the wildcard substitutes.

aIndex - The index of the wildcard in question for which to retrieve the substitute.

Returns:

The text substituting the wildcard at the given path pattern's wildcard index or null if there is none such substitute.

toWildcardReplacementsAt

public String[] toWildcardReplacementsAt(String aPath,
                                         int... aIndexes)

Description copied from interface: PathMatcher

Returns the wildcard substitutes for the wildcards in your path pattern (see PathMatcher.getPathPattern()) compared to the actual path (as of PathMatcher.toWildcardSubstitutes(String)). The text of the wildcard substitutes aligns to the indexes of the wildcard (from left to right) as defined in your path pattern.

Specified by:

toWildcardReplacementsAt in interface PathMatcher

Parameters:

aPath - The path for which to retrieve the wildcard substitutes.

aIndexes - The indexes of the wildcards in question for which to retrieve the substitutes.

Returns:

The text substituting the wildcards at the given path pattern's wildcard indexes or null if there is none such substitute.

toWildcardReplacement

public String toWildcardReplacement(String aPath,
                                    String aWildcardName)

Description copied from interface: PathMatcher

Returns the wildcard substitute for the wildcards in your path pattern (see PathMatcher.getPathPattern()) compared to the actual path (as of PathMatcher.toWildcardSubstitutes(String)). The text of the wildcard substitute aligns to the name of the wildcard (as defined in your path pattern).

Specified by:

toWildcardReplacement in interface PathMatcher

Parameters:

aPath - The path for which to retrieve the wildcard substitutes.

aWildcardName - The name of the wildcard in question for which to retrieve the substitute.

Returns:

The text substituting the wildcard with the given path pattern's wildcard name or null if there is none such substitute.

toWildcardReplacements

public String[] toWildcardReplacements(String aPath,
                                       String... aWildcardNames)

Description copied from interface: PathMatcher

Returns the wildcard substitutes for the wildcards in your path pattern (see PathMatcher.getPathPattern()) compared to the actual path (as of PathMatcher.toWildcardSubstitutes(String)). The text of the wildcard substitutes aligns to the order of the provided wildcard names (as defined in your path pattern).

Specified by:

toWildcardReplacements in interface PathMatcher

Parameters:

aPath - The path for which to retrieve the wildcard substitutes.

aWildcardNames - The names of the wildcards in question for which to retrieve the substitutes in the order of the provided names.

Returns:

The text substituting the wildcard with the given path pattern's wildcard names or null if there are none such substitute.

toPattern

public String toPattern()

For debugging purposes, retrieve the regex pattern created from the ANT path pattern.

Returns:

Returns the regex created from the ANT path pattern.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object