Path (Bridje VFS 0.6.0-beta8 API)

java.lang.Object
- org.bridje.vfs.Path

All Implemented Interfaces:

Iterable<Path>
```
public class Path
extends Object
implements Iterable<Path>
```
An utility class for virtual path management.
The path elements are separated by the "/" character.

Constructor Summary

Constructors
Constructor and Description

Path()
Default constructor for the Path class.

Path(String path)
Creates a Path object from String

Constructors
Constructor and Description
`Path()` Default constructor for the Path class.
`Path(String path)` Creates a Path object from String

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Path`	`getCanonicalPath()` This method creates a new path object that does not contains the (.) and (..) identifiers.
`String`	`getExtension()` Gets the extension for the last component of this path.
`String`	`getFirstElement()` Gets the first element of the path.
`String`	`getName()` Gets the first element of the path.
`Path`	`getNext()` Creates a new Path object that does not contains the first element of the current path.
`Path`	`getParent()` Creates a new Path object that represents the path to the parent object of the current path.
`String[]`	`getPathElements()` Gets an array with the list of elements for this path.
`int`	`hashCode()`
`boolean`	`hasNext()` Determines if this path has any element left.
`boolean`	`isLast()` Determines if this path is the last element path.
`boolean`	`isParent()` Determines if the first element of the path is the (..) identifier witch represents the parent folder.
`boolean`	`isRoot()` If this path is the root path "/".
`boolean`	`isSelf()` Determines if the first element of the path is the dot (.) character witch represents the current folder.
`Iterator<Path>`	`iterator()`
`Path`	`join(Path path)` Obtains the concatenation with another path.
`Path`	`join(String path)` Obtains the concatenation with a string.
`Path`	`leftTrim(Path path)` Remove the given path from the current path if the given path is a prefix of this path.
`boolean`	`startsWith(Path path)` Determines when ever this path starts with the given path.
`String`	`toString()` Gets a string representation of the current path.
`String`	`toString(String pathSep)` Gets a string representation of the current path, separated by the specified path separator.

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - Path
```
public Path()
```
    Default constructor for the Path class.
  - Path
```
public Path(String path)
```
    Creates a Path object from String
    
    Parameters:
    
    path - The String object representing the path
- Method Detail
  - getPathElements
```
public String[] getPathElements()
```
    Gets an array with the list of elements for this path.
    
    Returns:
    
    The list of elements for this path.
  - getFirstElement
```
public String getFirstElement()
```
    Gets the first element of the path.
    For example, if the path represented by this object equals to "usr/local", this method will return "usr".
    
    Returns:
    
    An String object that represents the first element of the path.
  - getName
```
public String getName()
```
    Gets the first element of the path.
    For example, if the path represented by this object equals to "usr/local/somefile", this method will return "somefile".
    
    Returns:
    
    An String object that represents the first element of the path.
  - getParent
```
public Path getParent()
```
    Creates a new Path object that represents the path to the parent object of the current path.
    For example, if the path represented by this object equals to "usr/local/somefile", this method will return a path object representing "usr/local".
    
    Returns:
    
    The Path object parent of this object, or null if this is the last path.
  - getNext
```
public Path getNext()
```
    Creates a new Path object that does not contains the first element of the current path.
    For example, if the path represented by this object equals to "usr/local/somefile", this method will return a path object representing "/local/somefile".
    
    Returns:
    
    The Path object without the first element of the current path, or null if this is the las path.
  - hasNext
```
public boolean hasNext()
```
    Determines if this path has any element left.
    For example, if the path represented by this object is a multiple element path like "usr/local" the this method will return true.
    
    Returns:
    
    true if this path is a multi element path, false otherwise.
  - isRoot
```
public boolean isRoot()
```
    If this path is the root path "/".
    
    Returns:
    
    true this path is the root path.
  - isSelf
```
public boolean isSelf()
```
    Determines if the first element of the path is the dot (.) character witch represents the current folder.
    
    Returns:
    
    true if the first element of the path is the dot (.) character, false otherwise.
  - isParent
```
public boolean isParent()
```
    Determines if the first element of the path is the (..) identifier witch represents the parent folder.
    
    Returns:
    
    true if the first element of the path is the (..) identifier, false otherwise.
  - isLast
```
public boolean isLast()
```
    Determines if this path is the last element path.
    If the path represented by this object is a single element path like "usr" then this method will return true.
    
    Returns:
    
    true if this path is a single element, false otherwise.
  - getCanonicalPath
```
public Path getCanonicalPath()
```
    This method creates a new path object that does not contains the (.) and (..) identifiers.
    For example, if the path represented by this element equals to "usr/./local/../etc", this method will return "usr/etc".
    
    Returns:
    
    A new Path object representing the canonical path of this object.
  - toString
```
public String toString()
```
    Gets a string representation of the current path.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    The String object representing the current path.
  - toString
```
public String toString(String pathSep)
```
    Gets a string representation of the current path, separated by the specified path separator.
    
    Parameters:
    
    pathSep - The path separator to be used.
    
    Returns:
    
    The String object representing the current path.
  - join
```
public Path join(Path path)
```
    Obtains the concatenation with another path.
    
    Parameters:
    
    path - the other path to concatenate.
    
    Returns:
    
    a new path with the concatenation.
  - join
```
public Path join(String path)
```
    Obtains the concatenation with a string.
    
    Parameters:
    
    path - the string to concatenate.
    
    Returns:
    
    a new path with the concatenation.
  - iterator
```
public Iterator<Path> iterator()
```
    Specified by:
    
    iterator in interface Iterable<Path>
    
    See Also:
    
    Iterable
  - getExtension
```
public String getExtension()
```
    Gets the extension for the last component of this path.
    
    Returns:
    
    The extension of the last component of this path.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - startsWith
```
public boolean startsWith(Path path)
```
    Determines when ever this path starts with the given path.
    
    Parameters:
    
    path - The prefix path.
    
    Returns:
    
    true if this path starts with the given path.
  - leftTrim
```
public Path leftTrim(Path path)
```
    Remove the given path from the current path if the given path is a prefix of this path.
    
    Parameters:
    
    path - The prefix path.
    
    Returns:
    
    the new trimmed path, or null if the given path is not a prefix for this path.

Class Path

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

Path

Path

Method Detail

getPathElements

getFirstElement

getName

getParent

getNext

hasNext

isRoot

isSelf

isParent

isLast

getCanonicalPath

toString

toString

join

join

iterator

getExtension

hashCode

equals

startsWith

leftTrim