TokenizedPath (Apache Ant API)
Date: 2012-02-26

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.tools.ant.types.selectors
Class TokenizedPath

    java.lang.Object
      org.apache.tools.ant.types.selectors.TokenizedPath

    public class TokenizedPath

extends java.lang.Object

Container for a path that has been split into its components.

Since:
  1.8.0

Field Summary
`static TokenizedPath` | `EMPTY_PATH` Instance that holds no tokens at all.

Constructor Summary
`TokenizedPath(java.lang.String path)` Initialize the TokenizedPath by parsing it.
`TokenizedPath(TokenizedPath parent, java.lang.String child)` Creates a new path as a child of another path.

Method Summary
`int` | `depth()` The depth (or length) of a path.
`boolean` | `equals(java.lang.Object o)` true if the original paths are equal.
`java.io.File` | `findFile(java.io.File base, boolean cs)` From `base` traverse the filesystem in order to find a file that matches the given name.
`int` | `hashCode()`
`boolean` | `isSymlink(java.io.File base)` Do we have to traverse a symlink when trying to reach path from basedir?
`TokenizedPattern` | `toPattern()` Creates a TokenizedPattern from the same tokens that make up this path.
`java.lang.String` | `toString()`

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

Field Detail

### EMPTY_PATH

    public static final TokenizedPath EMPTY_PATH

  Instance that holds no tokens at all.

Constructor Detail

### TokenizedPath

    public TokenizedPath(java.lang.String path)

  Initialize the TokenizedPath by parsing it.

  Parameters:
    `path` - The path to tokenize. Must not be `null`.

### TokenizedPath

    public TokenizedPath(TokenizedPath parent,
                         java.lang.String child)

  Creates a new path as a child of another path.

  Parameters:
    `parent` - the parent path
    `child` - the child, must not contain the file separator

Method Detail

### toString

    public java.lang.String toString()

  Overrides:
    `toString` in class `java.lang.Object`
  Returns:
    The original path String

### depth

    public int depth()

  The depth (or length) of a path.

### findFile

    public java.io.File findFile(java.io.File base,
                                 boolean cs)

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

  Parameters:
    `base` - base File (dir).
    `cs` - whether to scan case-sensitively.
  Returns:
    File object that points to the file in question or null.

### isSymlink

    public boolean isSymlink(java.io.File base)

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

  Parameters:
    `base` - base File (dir).

### equals

    public boolean equals(java.lang.Object o)

  true if the original paths are equal.

  Overrides:
    `equals` in class `java.lang.Object`

### hashCode

    public int hashCode()

  Overrides:
    `hashCode` in class `java.lang.Object`

### toPattern

    public TokenizedPattern toPattern()

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

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD