Top Description Fields Constructors Methods
org.apache.tools.ant.types.selectors

public Class TokenizedPattern

extends Object
Class Inheritance
Imports
java.io.File, java.util.function.Predicate, java.util.stream.Stream
Provides reusable path pattern matching. TokenizedPattern is preferable to equivalent SelectorUtils methods if you need to execute multiple matching with the same pattern because here the pattern itself will be parsed only once.
Since
1.8.0
See Also
SelectorUtils#matchPath(String, String), SelectorUtils#matchPath(String, String, boolean)

Field Summary

Modifier and TypeField and Description
public static final TokenizedPattern
EMPTY_PATTERN

Instance that holds no tokens at all.

private final String
pattern

private final String[]
tokenizedPattern

Constructor Summary

AccessConstructor and Description
public
TokenizedPattern(String
The pattern to match against. Must not be null.
pattern)

Initialize the TokenizedPattern by parsing it.

pack-priv
TokenizedPattern(String pattern, String[] tokens)

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

boolean
containsPattern(String
String
pat)

Does the tokenized pattern contain the given string?

public int

Returns:

int
depth()

Get the depth (or length) of a pattern.

public boolean

Returns:

boolean
endsWith(String
String
s)

Learn whether the last token equals the given string.

public boolean
equals(Object
Object
o)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public String

Returns:

String
getPattern()

Get the pattern.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public boolean

Returns:

true if the pattern matches against the string, or false otherwise.
matchPath(TokenizedPath
The path to match, as a String. Must not be null.
path, boolean
Whether or not matching should be performed case sensitively.
isCaseSensitive)

Tests whether or not a given path matches a given pattern.

public boolean

Returns:

boolean
matchStartOf(TokenizedPath
TokenizedPath
path, boolean
boolean
caseSensitive)

Tests whether or not this pattern matches the start of a path.

public TokenizedPath

Returns:

the leftmost part of the pattern without wildcards
rtrimWildcardTokens()

Returns a new TokenizedPath where all tokens of this pattern to the right containing wildcards have been removed.

public String

Returns:

The pattern String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
public TokenizedPattern

Returns:

TokenizedPattern
withoutLastToken()

Returns a new pattern without the last token of this pattern.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

EMPTY_PATTERNback to summary
public static final TokenizedPattern EMPTY_PATTERN

Instance that holds no tokens at all.

patternback to summary
private final String pattern
tokenizedPatternback to summary
private final String[] tokenizedPattern

Constructor Detail

TokenizedPatternback to summary
public TokenizedPattern(String pattern)

Initialize the TokenizedPattern by parsing it.

Parameters
pattern:String

The pattern to match against. Must not be null.

TokenizedPatternback to summary
pack-priv TokenizedPattern(String pattern, String[] tokens)

Method Detail

containsPatternback to summary
public boolean containsPattern(String pat)

Does the tokenized pattern contain the given string?

Parameters
pat:String

String

Returns:boolean

boolean

depthback to summary
public int depth()

Get the depth (or length) of a pattern.

Returns:int

int

endsWithback to summary
public boolean endsWith(String s)

Learn whether the last token equals the given string.

Parameters
s:String

String

Returns:boolean

boolean

equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. true if the original patterns are equal.

Parameters
o:Object

Object

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

getPatternback to summary
public String getPattern()

Get the pattern.

Returns:String

String

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

matchPathback to summary
public boolean matchPath(TokenizedPath path, boolean isCaseSensitive)

Tests whether or not a given path matches a given pattern.

Parameters
path:TokenizedPath

The path to match, as a String. Must not be null.

isCaseSensitive:boolean

Whether or not matching should be performed case sensitively.

Returns:boolean

true if the pattern matches against the string, or false otherwise.

matchStartOfback to summary
public boolean matchStartOf(TokenizedPath path, boolean caseSensitive)

Tests whether or not this pattern matches the start of a path.

Parameters
path:TokenizedPath

TokenizedPath

caseSensitive:boolean

boolean

Returns:boolean

boolean

rtrimWildcardTokensback to summary
public TokenizedPath rtrimWildcardTokens()

Returns a new TokenizedPath where all tokens of this pattern to the right containing wildcards have been removed.

Returns:TokenizedPath

the leftmost part of the pattern without wildcards

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

The pattern String

withoutLastTokenback to summary
public TokenizedPattern withoutLastToken()

Returns a new pattern without the last token of this pattern.

Returns:TokenizedPattern

TokenizedPattern