Apache Ant Core 1.10.14 · org.apache.tools.ant.types.selectors.TokenizedPath

Field Summary

Modifier and Type	Field and Description
private static final boolean[]	CS_SCAN_ONLY iterations for case-sensitive scanning.
private static final boolean[]	CS_THEN_NON_CS iterations for non-case-sensitive scanning.
public static final TokenizedPath	EMPTY_PATH Instance that holds no tokens at all.
private static final FileUtils	FILE_UTILS Helper.
private final String	path
private final String[]	tokenizedPath

Constructor Summary

Access	Constructor and Description
public	TokenizedPath(String The path to tokenize. Must not be `null`. path) Initialize the TokenizedPath by parsing it.
public	TokenizedPath(TokenizedPath the parent path parent, String the child, must not contain the file separator child) Creates a new path as a child of another path.
pack-priv	TokenizedPath(String path, String[] tokens)

Method Summary

Modifier and Type	Method and Description
public int	Returns: int depth() The depth (or length) of a path.
public boolean	Returns: boolean equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. true if the original paths are equal.
public File	Returns: File object that points to the file in question or null. findFile(File base File (dir). base, final boolean whether to scan case-sensitively. cs) From `base` traverse the filesystem in order to find a file that matches the given name.
private static File	Returns: File object that points to the file in question or null. findFile(File base File (dir) - must not be null. base, final String[] array of path elements (dirs...file). pathElements, final boolean whether to scan case-sensitively. cs) From `base` traverse the filesystem in order to find a file that matches the given stack of names.
pack-priv String[]	getTokens()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public boolean	Returns: boolean isSymlink(File base File (dir). base) Do we have to traverse a symlink when trying to reach path from basedir?
public TokenizedPattern	Returns: TokenizedPattern toPattern() Creates a TokenizedPattern from the same tokens that make up this path.
public String	Returns: The original path String toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

CS_SCAN_ONLY	back to summary
private static final boolean[] CS_SCAN_ONLY iterations for case-sensitive scanning.

CS_THEN_NON_CS	back to summary
private static final boolean[] CS_THEN_NON_CS iterations for non-case-sensitive scanning.

EMPTY_PATH	back to summary
public static final TokenizedPath EMPTY_PATH Instance that holds no tokens at all.

FILE_UTILS	back to summary
private static final FileUtils FILE_UTILS Helper.

path	back to summary
private final String path

tokenizedPath	back to summary
private final String[] tokenizedPath

Constructor Detail

TokenizedPath back to summary

TokenizedPath	back to summary
public TokenizedPath(String path) Initialize the TokenizedPath by parsing it. Parameters path:String The path to tokenize. Must not be `null`.

public TokenizedPath(String path)

Initialize the TokenizedPath by parsing it.

Parameters

path:String: The path to tokenize. Must not be null.

TokenizedPath	back to summary
public TokenizedPath(TokenizedPath parent, String child) Creates a new path as a child of another path. Parameters parent:TokenizedPath the parent path child:String the child, must not contain the file separator

TokenizedPath

back to summary

public TokenizedPath(TokenizedPath parent, String child)

Creates a new path as a child of another path.

Parameters

parent:TokenizedPath: the parent path
child:String: the child, must not contain the file separator

TokenizedPath	back to summary
pack-priv TokenizedPath(String path, String[] tokens)

Method Detail

depth	back to summary
public int depth() The depth (or length) of a path. Returns:int int

depth

back to summary

public int depth()

The depth (or length) of a path.

Returns:int: int

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. true if the original paths are equal. Parameters o:Object Doc from java.lang.Object.equals. the reference object with which to compare. Returns:boolean boolean Annotations @Override

equals

back to summary

public boolean equals(Object o)

Overrides java.lang.Object.equals.

true if the original paths are equal.

Parameters

o:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

boolean

Annotations

@Override

findFile back to summary

findFile	back to summary
public File findFile(File base, final boolean cs) From `base` traverse the filesystem in order to find a file that matches the given name. Parameters base:File base File (dir). cs:boolean whether to scan case-sensitively. Returns:File File object that points to the file in question or null.

public File findFile(File base, final boolean cs)

From base traverse the filesystem in order to find a file that matches the given name.

Parameters

base:File: base File (dir).
cs:boolean: whether to scan case-sensitively.

Returns:File

File object that points to the file in question or null.

findFile back to summary

findFile	back to summary
private static File findFile(File base, final String[] pathElements, final boolean cs) From `base` traverse the filesystem in order to find a file that matches the given stack of names. Parameters base:File base File (dir) - must not be null. pathElements:String[] array of path elements (dirs...file). cs:boolean whether to scan case-sensitively. Returns:File File object that points to the file in question or null.

private static File findFile(File base, final String[] pathElements, final boolean cs)

From base traverse the filesystem in order to find a file that matches the given stack of names.

Parameters

base:File: base File (dir) - must not be null.
pathElements:String[]: array of path elements (dirs...file).
cs:boolean: whether to scan case-sensitively.

Returns:File

File object that points to the file in question or null.

getTokens	back to summary
pack-priv String[] getTokens()

hashCode back to summary

hashCode	back 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. Annotations @Override

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.

Annotations

@Override

isSymlink	back to summary
public boolean isSymlink(File base) Do we have to traverse a symlink when trying to reach path from basedir? Parameters base:File base File (dir). Returns:boolean boolean

isSymlink

back to summary

public boolean isSymlink(File base)

Do we have to traverse a symlink when trying to reach path from basedir?

Parameters

base:File: base File (dir).

Returns:boolean

boolean

toPattern	back to summary
public TokenizedPattern toPattern() Creates a TokenizedPattern from the same tokens that make up this path. Returns:TokenizedPattern TokenizedPattern

toPattern

back to summary

public TokenizedPattern toPattern()

Creates a TokenizedPattern from the same tokens that make up this path.

Returns:TokenizedPattern: TokenizedPattern

toString	back 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 original path String Annotations @Override

toString

back 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 original path String

Annotations

@Override

public Class TokenizedPath

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail