TachyonURI (Tachyon Common 0.8.2 API)

java.lang.Object
- tachyon.TachyonURI

All Implemented Interfaces:

Comparable<TachyonURI>
```
public final class TachyonURI
extends Object
implements Comparable<TachyonURI>
```
It uses a hierarchical URI internally. URI requires that String is escaped, TachyonURI does not. Does not support fragment or query in the URI.

Field Summary

Fields
Modifier and Type Field and Description

static String CUR_DIR

static TachyonURI EMPTY_URI

static String SEPARATOR

static String WILDCARD

Fields
Modifier and Type	Field and Description
`static String`	`CUR_DIR`
`static TachyonURI`	`EMPTY_URI`
`static String`	`SEPARATOR`
`static String`	`WILDCARD`

Constructor Summary

Constructors
Constructor and Description
`TachyonURI(String pathStr)` Construct a TachyonURI from a String.
`TachyonURI(String scheme, String authority, String path)` Construct a TachyonURI from components.
`TachyonURI(TachyonURI parent, TachyonURI child)` Resolve a child TachyonURI against a parent TachyonURI.

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`compareTo(TachyonURI other)`
`boolean`	`containsWildcard()` Whether or not the TachyonURI contains wildcard(s).
`boolean`	`equals(Object o)`
`String`	`getAuthority()` Gets the authority of the TachyonURI.
`int`	`getDepth()` Return the number of elements of the path component of the TachyonURI.
`String`	`getHost()` Gets the host of the TachyonURI.
`String`	`getLeadingPath(int n)` Get the first n components of the TachyonURI path.
`String`	`getName()` Get the final component of the TachyonURI.
`TachyonURI`	`getParent()` Get the parent of this TachyonURI or null if at root.
`String`	`getPath()` Gets the path component of the TachyonURI.
`int`	`getPort()` Gets the port of the TachyonURI.
`String`	`getScheme()` Get the scheme of the TachyonURI.
`boolean`	`hasAuthority()` Tells if the TachyonURI has authority or not.
`int`	`hashCode()`
`boolean`	`hasScheme()` Tells if this TachyonURI has scheme or not.
`boolean`	`isAbsolute()` Tells whether or not the TachyonURI is absolute.
`boolean`	`isPathAbsolute()` Tells whether or not the path component of the TachyonURI is absolute.
`boolean`	`isRoot()` Tells whether or not the TachyonURI is root.
`TachyonURI`	`join(String suffix)` Append additional path elements to the end of a TachyonURI.
`TachyonURI`	`join(TachyonURI suffix)` Append additional path elements to the end of a TachyonURI.
`String`	`toString()` Illegal characters unescaped in the string, for glob processing, etc.

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

- Field Detail
  - SEPARATOR
```
public static final String SEPARATOR
```
    See Also:
    Constant Field Values
  - CUR_DIR
```
public static final String CUR_DIR
```
    See Also:
    Constant Field Values
  - WILDCARD
```
public static final String WILDCARD
```
    See Also:
    Constant Field Values
  - EMPTY_URI
```
public static final TachyonURI EMPTY_URI
```
- Constructor Detail
  - TachyonURI
```
public TachyonURI(String pathStr)
```
    Construct a TachyonURI from a String. Path strings are URIs, but with unescaped elements and some additional normalization.
    
    Parameters:
    pathStr - path to construct the TachyonURI from
  - TachyonURI
```
public TachyonURI(String scheme,
          String authority,
          String path)
```
    Construct a TachyonURI from components.
    
    Parameters:
    scheme - the scheme of the path. e.g. tachyon, hdfs, s3, file, null, etc.
    authority - the authority of the path. e.g. localhost:19998, 203.1.2.5:8080
    path - the path component of the URI. e.g. /abc/c.txt, /a b/c/c.txt
  - TachyonURI
```
public TachyonURI(TachyonURI parent,
          TachyonURI child)
```
    Resolve a child TachyonURI against a parent TachyonURI.
    
    Parameters:
    parent - the parent
    child - the child
- Method Detail
  - compareTo
```
public int compareTo(TachyonURI other)
```
    Specified by:
    
    compareTo in interface Comparable<TachyonURI>
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - getAuthority
```
public String getAuthority()
```
    Gets the authority of the TachyonURI.
    
    Returns:
    the authority, null if it does not have one
  - getDepth
```
public int getDepth()
```
    Return the number of elements of the path component of the TachyonURI.
```
 /                                  = 0
 /a                                 = 1
 /a/b/c.txt                         = 3
 /a/b/                              = 3
 a/b                                = 2
 a\b                                = 2
 tachyon://localhost:1998/          = 0
 tachyon://localhost:1998/a         = 1
 tachyon://localhost:1998/a/b.txt   = 2
 C:\a                               = 1
 C:                                 = 0
 
```
    Returns:
    the depth
  - getLeadingPath
```
public String getLeadingPath(int n)
```
    Get the first n components of the TachyonURI path. There is no trailing separator as the path will be normalized by normalizePath().
```
 /a/b/c, 0              = /
 /a/b/c, 1              = /a
 /a/b/c, 2              = /a/b
 /a/b/c, 3              = /a/b/c
 /a/b/c, 4              = null
 
```
    Parameters:
    n - identifies the number of path components to get
    
    Returns:
    the first n path components, null if the path has less than n components
  - containsWildcard
```
public boolean containsWildcard()
```
    Whether or not the TachyonURI contains wildcard(s).
    
    Returns:
    boolean that indicates whether the TachyonURI contains wildcard(s)
  - getHost
```
public String getHost()
```
    Gets the host of the TachyonURI.
    
    Returns:
    the host, null if it does not have one
  - getName
```
public String getName()
```
    Get the final component of the TachyonURI.
    
    Returns:
    the final component of the TachyonURI
  - getParent
```
public TachyonURI getParent()
```
    Get the parent of this TachyonURI or null if at root.
    
    Returns:
    the parent of this TachyonURI or null if at root
  - getPath
```
public String getPath()
```
    Gets the path component of the TachyonURI.
    
    Returns:
    the path
  - getPort
```
public int getPort()
```
    Gets the port of the TachyonURI.
    
    Returns:
    the port, -1 if it does not have one
  - getScheme
```
public String getScheme()
```
    Get the scheme of the TachyonURI.
    
    Returns:
    the scheme, null if there is no scheme
  - hasAuthority
```
public boolean hasAuthority()
```
    Tells if the TachyonURI has authority or not.
    
    Returns:
    true if it has, false otherwise
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - hasScheme
```
public boolean hasScheme()
```
    Tells if this TachyonURI has scheme or not.
    
    Returns:
    true if it has, false otherwise
  - isAbsolute
```
public boolean isAbsolute()
```
    Tells whether or not the TachyonURI is absolute.
    A TachyonURI is absolute if, and only if, it has a scheme component.
    
    Returns:
    true if, and only if, this TachyonURI is absolute
  - isPathAbsolute
```
public boolean isPathAbsolute()
```
    Tells whether or not the path component of the TachyonURI is absolute.
    A path is absolute if, and only if, it starts with root.
    
    Returns:
    true if, and only if, the TachyonURI's path component is absolute
  - isRoot
```
public boolean isRoot()
```
    Tells whether or not the TachyonURI is root.
    A URI is root if its path equals to "/"
    
    Returns:
    true if, and only if, this URI is root
  - join
```
public TachyonURI join(String suffix)
```
    Append additional path elements to the end of a TachyonURI.
    
    Parameters:
    suffix - the suffix to add
    
    Returns:
    the new TachyonURI
  - join
```
public TachyonURI join(TachyonURI suffix)
```
    Append additional path elements to the end of a TachyonURI.
    
    Parameters:
    suffix - the suffix to add
    
    Returns:
    the new TachyonURI
  - toString
```
public String toString()
```
    Illegal characters unescaped in the string, for glob processing, etc.
    
    Overrides:
    
    toString in class Object

Class TachyonURI

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SEPARATOR

CUR_DIR

WILDCARD

EMPTY_URI

Constructor Detail

TachyonURI

TachyonURI

TachyonURI

Method Detail

compareTo

equals

getAuthority

getDepth

getLeadingPath

containsWildcard

getHost

getName

getParent

getPath

getPort

getScheme

hasAuthority

hashCode

hasScheme

isAbsolute

isPathAbsolute

isRoot

join

join

toString