Package org.refcodes.matcher
Interface PathMatcher
-
- All Superinterfaces:
org.refcodes.mixin.DelimiterAccessor
,Matcher<java.lang.String>
- All Known Implementing Classes:
PathMatcherImpl
public interface PathMatcher extends Matcher<java.lang.String>, org.refcodes.mixin.DelimiterAccessor
PathMatcher
, matching its ANT like path pattern against the path provided to theisMatching(String)
and the like methods. ThePathMatcher
applies the following rules from the ANT path pattern to the path provided viaisMatching(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. The single asterisk ("*"), the double asterisk ("**") and the question mark ("?") we refer to as wildcards: You get an array with the substitutes of the wildcards using the methodtoWildcardSubstitutes(String)
(or null, if yourString
does not match your path pattern). You may name a wildcard by prefixing it with "${someWildcardName}=". For example a named wildcard may look as follows: "${arg1}=*" or "${arg2}=**" or "${arg3}=?". A placeholder "${arg1}" with no wildcard assignment "=" is equivalent to "${arg1}=*". The regular expression pattern construction is inspired by: "http://stackoverflow.com/questions/33171025/regex-matching-an-ant-path"
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.refcodes.mixin.DelimiterAccessor
org.refcodes.mixin.DelimiterAccessor.DelimiterBuilder<B extends org.refcodes.mixin.DelimiterAccessor.DelimiterBuilder<B>>, org.refcodes.mixin.DelimiterAccessor.DelimiterMutator, org.refcodes.mixin.DelimiterAccessor.DelimiterProperty
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getPathPattern()
Returns the path pattern being used by thePathMatcher
.java.lang.String[]
getWildcardNames()
Retrieves the list of wildcard names identifying the wildcards as specified by the path pattern.boolean
isMatching(java.lang.String aPath)
The this method applies the following rules from the configured ANT path pattern to the path provided viaisMatching(String)
method: A single asterisk ("*") matches zero or more characters within a path name.java.lang.String
toWildcardReplacement(java.lang.String aPath, java.lang.String aWildcardName)
Returns the wildcard substitute for the wildcards in your path pattern (seegetPathPattern()
) compared to the actual path (as oftoWildcardSubstitutes(String)
).java.lang.String
toWildcardReplacementAt(java.lang.String aPath, int aIndex)
Returns the wildcard substitute for the wildcards in your path pattern (seegetPathPattern()
) compared to the actual path (as oftoWildcardSubstitutes(String)
).java.lang.String[]
toWildcardReplacements(java.lang.String aPath)
Returns an array of the wildcard substitutes for the wildcards in your path pattern (seegetPathPattern()
) compared to the actual path (as oftoWildcardSubstitutes(String)
).java.lang.String[]
toWildcardReplacements(java.lang.String aPath, java.lang.String... aWildcardNames)
Returns the wildcard substitutes for the wildcards in your path pattern (seegetPathPattern()
) compared to the actual path (as oftoWildcardSubstitutes(String)
).java.lang.String[]
toWildcardReplacementsAt(java.lang.String aPath, int... aIndexes)
Returns the wildcard substitutes for the wildcards in your path pattern (seegetPathPattern()
) compared to the actual path (as oftoWildcardSubstitutes(String)
).WildcardSubstitutes
toWildcardSubstitutes(java.lang.String aPath)
Returns all available wildcard substitutes as well as the named wildcard substitutes.
-
-
-
Method Detail
-
isMatching
boolean isMatching(java.lang.String aPath)
The this method applies the following rules from the configured ANT path pattern to the path provided viaisMatching(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 Tests whether the given event is matching the mathcer's criteria.- Specified by:
isMatching
in interfaceMatcher<java.lang.String>
- Parameters:
aPath
- The matchee used for testing matchability.- Returns:
- True in case the matchee matches the matcher's criteria, else false.
-
getPathPattern
java.lang.String getPathPattern()
Returns the path pattern being used by thePathMatcher
.- Returns:
- The path pattern being used.
-
toWildcardSubstitutes
WildcardSubstitutes toWildcardSubstitutes(java.lang.String aPath)
Returns all available wildcard substitutes as well as the named wildcard substitutes.- Parameters:
aPath
- The path for which to retrieve the wildcard substitutes.- Returns:
- The
WildcardSubstitutes
of the wildcards being substituted.
-
toWildcardReplacements
java.lang.String[] toWildcardReplacements(java.lang.String aPath)
Returns an array of the wildcard substitutes for the wildcards in your path pattern (seegetPathPattern()
) compared to the actual path (as oftoWildcardSubstitutes(String)
). The order of the wildcard substitutes aligns to the order of the wildcards (from left to right) defined in your path pattern.- 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
java.lang.String toWildcardReplacementAt(java.lang.String aPath, int aIndex)
Returns the wildcard substitute for the wildcards in your path pattern (seegetPathPattern()
) compared to the actual path (as oftoWildcardSubstitutes(String)
). The text of the wildcard substitute aligns to the index of the wildcard (from left to right) as defined in your path pattern.- 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
java.lang.String[] toWildcardReplacementsAt(java.lang.String aPath, int... aIndexes)
Returns the wildcard substitutes for the wildcards in your path pattern (seegetPathPattern()
) compared to the actual path (as oftoWildcardSubstitutes(String)
). The text of the wildcard substitutes aligns to the indexes of the wildcard (from left to right) as defined in your path pattern.- 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
java.lang.String toWildcardReplacement(java.lang.String aPath, java.lang.String aWildcardName)
Returns the wildcard substitute for the wildcards in your path pattern (seegetPathPattern()
) compared to the actual path (as oftoWildcardSubstitutes(String)
). The text of the wildcard substitute aligns to the name of the wildcard (as defined in your path pattern).- 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
java.lang.String[] toWildcardReplacements(java.lang.String aPath, java.lang.String... aWildcardNames)
Returns the wildcard substitutes for the wildcards in your path pattern (seegetPathPattern()
) compared to the actual path (as oftoWildcardSubstitutes(String)
). The text of the wildcard substitutes aligns to the order of the provided wildcard names (as defined in your path pattern).- 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.
-
getWildcardNames
java.lang.String[] getWildcardNames()
Retrieves the list of wildcard names identifying the wildcards as specified by the path pattern.- Returns:
- The wild card names or null of no wild card names have been defined.
-
-