tachyon

Class TachyonURI

java.lang.Object

tachyon.TachyonURI

All Implemented Interfaces:

Comparable<TachyonURI>

public 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 String	SEPARATOR

Constructor Summary

Constructors

Constructor and Description
TachyonURI(String pathStr) Construct a path from a String.
TachyonURI(String scheme, String authority, String path) Construct a Tachyon URI 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	equals(Object o)
String	getAuthority() Gets the authority of this TachyonURI
int	getDepth() Return the number of elements of the path component of the TachyonURI.
String	getHost() Gets the host of this TachyonURI.
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 part component of this TachyonURI.
int	getPort() Gets the port of this TachyonURI.
String	getScheme() Get the scheme of the Tachyon URI.
boolean	hasAuthority() Tells if this TachyonURI has authority or not.
int	hashCode()
boolean	hasScheme() Tells if this TachyonURI has scheme or not.
boolean	isAbsolute() Tells whether or not this URI is absolute.
boolean	isPathAbsolute() Tells whether or not the path component of this TachyonURI is absolute.
TachyonURI	join(String suffix) Add a suffix to the end of the Tachyon URI.
TachyonURI	join(TachyonURI suffix) Add a suffix to the end of the Tachyon URI.
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

Constructor Detail

TachyonURI

public TachyonURI(String pathStr)

Construct a path from a String. Path strings are URIs, but with unescaped elements and some additional normalization.

TachyonURI

public TachyonURI(String scheme,
          String authority,
          String path)

Construct a Tachyon URI 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 this 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
 C:\a                               -> 1
 C:                                 -> 0
 tachyon://localhost:1998/          -> 0
 tachyon://localhost:1998/a         -> 1
 tachyon://localhost:1998/a/b.txt   -> 2
 

Returns:

the depth

getHost

public String getHost()

Gets the host of this 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 part component of this TachyonURI.

Returns:

the path.

getPort

public int getPort()

Gets the port of this TachyonURI.

Returns:

the port, -1 if it does not have one.

getScheme

public String getScheme()

Get the scheme of the Tachyon URI.

Returns:

the scheme, null if there is no scheme.

hasAuthority

public boolean hasAuthority()

Tells if this 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 this URI is absolute.

A URI is absolute if, and only if, it has a scheme component.

Returns:

true if, and only if, this URI is absolute

isPathAbsolute

public boolean isPathAbsolute()

Tells whether or not the path component of this TachyonURI is absolute.

A path is absolute if, and only if, it starts with root.

Returns:

true if, and only if, this TachyonURI's path component is absolute

join

public TachyonURI join(String suffix)

Add a suffix to the end of the Tachyon URI.

Parameters:

suffix - the suffix to add

Returns:

the new TachyonURI

join

public TachyonURI join(TachyonURI suffix)

Add a suffix to the end of the Tachyon URI.

Parameters:

TachyonURI - 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