AlluxioURI (Alluxio Parent 305-SNAPSHOT API)

java.lang.Object
- alluxio.AlluxioURI

All Implemented Interfaces:

Serializable, Comparable<AlluxioURI>
```
@PublicApi
 @ThreadSafe
public final class AlluxioURI
extends Object
implements Comparable<AlluxioURI>, Serializable
```
This class represents a URI in the Alluxio system. This AlluxioURI can represent resources in the Alluxio namespace, as well as UFS namespaces. AlluxioURI supports more than just strict URI. Some examples: * Windows paths * C:\ * D:\path\to\file * E:\path\to\skip\..\file * URI with multiple scheme components * scheme://host:123/path * scheme:part2//host:123/path * scheme:part2://host:123/path * scheme:part2:part3//host:123/path * scheme:part2:part3://host:123/path Does not support fragment in the URI.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String CUR_DIR

static AlluxioURI EMPTY_URI

static String SEPARATOR

static String WILDCARD

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

Constructor Summary

Constructors
Constructor and Description
`AlluxioURI(AlluxioURI parent, AlluxioURI child)` Resolves a child `AlluxioURI` against a parent `AlluxioURI`.
`AlluxioURI(AlluxioURI baseURI, String newPath, boolean checkNormalization)` Constructs an `AlluxioURI` from a base URI and a new path component.
`AlluxioURI(String pathStr)` Constructs an `AlluxioURI` from a String.
`AlluxioURI(String scheme, Authority authority, String path)` Constructs an `AlluxioURI` from components.
`AlluxioURI(String scheme, Authority authority, String path, Map<String,String> queryMap)` Constructs an `AlluxioURI` from components.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(AlluxioURI other)`
`boolean`	`containsWildcard()` Whether or not the `AlluxioURI` contains wildcard(s).
`boolean`	`equals(Object o)`
`Authority`	`getAuthority()`
`int`	`getDepth()` Returns the number of elements of the path component of the `AlluxioURI`.
`String`	`getLeadingPath(int n)` Gets the first n components of the `AlluxioURI` path.
`String`	`getName()` Gets the final component of the `AlluxioURI`.
`AlluxioURI`	`getParent()` Get the parent of this `AlluxioURI` or null if at root.
`String`	`getPath()` Gets the path component of the `AlluxioURI`.
`Map<String,String>`	`getQueryMap()` Gets the map of query parameters.
`String`	`getRootPath()`
`String`	`getScheme()` Gets the scheme of the `AlluxioURI`.
`boolean`	`hasAuthority()` Tells if the `AlluxioURI` has authority or not.
`String`	`hash()` Computes the hash of this URI, with SHA-256, or MD5, or simple hashCode().
`static String`	`hash(String uri)` Computes the hash of this URI, with SHA-256, or MD5, or simple hashCode().
`int`	`hashCode()`
`boolean`	`hasScheme()` Tells if this `AlluxioURI` has scheme or not.
`static boolean`	`hasWindowsDrive(String path, boolean slashed)` Checks if the path is a windows path.
`boolean`	`isAbsolute()` Tells whether or not the `AlluxioURI` is absolute.
`boolean`	`isAncestorOf(AlluxioURI alluxioURI)` Returns true if the current AlluxioURI is an ancestor of another AlluxioURI.
`boolean`	`isPathAbsolute()` Tells whether or not the path component of the `AlluxioURI` is absolute.
`boolean`	`isRoot()` Tells whether or not the `AlluxioURI` is root.
`AlluxioURI`	`join(AlluxioURI suffix)` Append additional path elements to the end of an `AlluxioURI`.
`AlluxioURI`	`join(String suffix)` Append additional path elements to the end of an `AlluxioURI`.
`AlluxioURI`	`joinUnsafe(String suffix)` Append additional path elements to the end of an `AlluxioURI`.
`static String`	`normalizePath(String path)` Normalize the path component of the `AlluxioURI`, by replacing all "//" and "\\" with "/", and trimming trailing slash from non-root path (ignoring windows drive).
`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 AlluxioURI EMPTY_URI
```
- Constructor Detail
  - AlluxioURI
```
public AlluxioURI(String pathStr)
```
    Constructs an AlluxioURI from a String. Path strings are URIs, but with unescaped elements and some additional normalization.
    
    Parameters:
    
    pathStr - path to construct the AlluxioURI from
  - AlluxioURI
```
public AlluxioURI(String scheme,
                  Authority authority,
                  String path)
```
    Constructs an AlluxioURI from components.
    
    Parameters:
    
    scheme - the scheme of the path. e.g. alluxio, hdfs, s3, file, null, etc
    
    authority - the authority of the path
    
    path - the path component of the URI. e.g. /abc/c.txt, /a b/c/c.txt
  - AlluxioURI
```
public AlluxioURI(String scheme,
                  Authority authority,
                  String path,
                  Map<String,String> queryMap)
```
    Constructs an AlluxioURI from components.
    
    Parameters:
    
    scheme - the scheme of the path. e.g. alluxio, hdfs, s3, file, null, etc
    
    authority - the authority of the path
    
    path - the path component of the URI. e.g. /abc/c.txt, /a b/c/c.txt
    
    queryMap - the (nullable) map of key/value pairs for the query component of the URI
  - AlluxioURI
```
public AlluxioURI(AlluxioURI parent,
                  AlluxioURI child)
```
    Resolves a child AlluxioURI against a parent AlluxioURI.
    
    Parameters:
    
    parent - the parent
    
    child - the child
  - AlluxioURI
```
public AlluxioURI(AlluxioURI baseURI,
                  String newPath,
                  boolean checkNormalization)
```
    Constructs an AlluxioURI from a base URI and a new path component.
    
    Parameters:
    
    baseURI - the base uri
    
    newPath - the new path component
    
    checkNormalization - if true, will check if the path requires normalization
- Method Detail
  - compareTo
```
public int compareTo(AlluxioURI other)
```
    Specified by:
    
    compareTo in interface Comparable<AlluxioURI>
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - getAuthority
```
public Authority getAuthority()
```
    Returns:
    
    the authority of the AlluxioURI
  - getDepth
```
public int getDepth()
```
    Returns the number of elements of the path component of the AlluxioURI.
```
 /                                  = 0
 .                                  = 0
 /a                                 = 1
 /a/b/c.txt                         = 3
 /a/b/                              = 3
 a/b                                = 2
 a\b                                = 2
 alluxio://localhost:19998/         = 0
 alluxio://localhost:19998/a        = 1
 alluxio://localhost:19998/a/b.txt  = 2
 C:\a                               = 1
 C:                                 = 0
 
```
    Returns:
    
    the depth
  - getLeadingPath
```
@Nullable
public String getLeadingPath(int n)
```
    Gets the first n components of the AlluxioURI 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 AlluxioURI contains wildcard(s).
    
    Returns:
    
    boolean that indicates whether the AlluxioURI contains wildcard(s)
  - getName
```
public String getName()
```
    Gets the final component of the AlluxioURI.
    
    Returns:
    
    the final component of the AlluxioURI
  - getParent
```
@Nullable
public AlluxioURI getParent()
```
    Get the parent of this AlluxioURI or null if at root.
    
    Returns:
    
    the parent of this AlluxioURI or null if at root
  - getPath
```
public String getPath()
```
    Gets the path component of the AlluxioURI.
    
    Returns:
    
    the path
  - getQueryMap
```
public Map<String,String> getQueryMap()
```
    Gets the map of query parameters.
    
    Returns:
    
    the map of query parameters
  - getScheme
```
@Nullable
public String getScheme()
```
    Gets the scheme of the AlluxioURI.
    
    Returns:
    
    the scheme, null if there is no scheme
  - getRootPath
```
public String getRootPath()
```
    Returns:
    
    the normalized path stripped of the folder path component
  - hasAuthority
```
public boolean hasAuthority()
```
    Tells if the AlluxioURI 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 AlluxioURI has scheme or not.
    
    Returns:
    
    true if it has, false otherwise
  - hasWindowsDrive
```
public static boolean hasWindowsDrive(String path,
                                      boolean slashed)
```
    Checks if the path is a windows path. This should be platform independent.
    
    Parameters:
    
    path - the path to check
    
    slashed - if the path starts with a slash
    
    Returns:
    
    true if it is a windows path, false otherwise
  - isAbsolute
```
public boolean isAbsolute()
```
    Tells whether or not the AlluxioURI is absolute.
    An AlluxioURI is absolute if, and only if, it has a scheme component.
    
    Returns:
    
    true if, and only if, this AlluxioURI is absolute
  - isPathAbsolute
```
public boolean isPathAbsolute()
```
    Tells whether or not the path component of the AlluxioURI is absolute.
    A path is absolute if, and only if, it starts with root.
    
    Returns:
    
    true if, and only if, the AlluxioURI's path component is absolute
  - isRoot
```
public boolean isRoot()
```
    Tells whether or not the AlluxioURI is root.
    A URI is root if its path equals to "/"
    
    Returns:
    
    true if, and only if, this URI is root
  - join
```
public AlluxioURI join(String suffix)
```
    Append additional path elements to the end of an AlluxioURI.
    
    Parameters:
    
    suffix - the suffix to add
    
    Returns:
    
    the new AlluxioURI
  - join
```
public AlluxioURI join(AlluxioURI suffix)
```
    Append additional path elements to the end of an AlluxioURI.
    
    Parameters:
    
    suffix - the suffix to add
    
    Returns:
    
    the new AlluxioURI
  - joinUnsafe
```
public AlluxioURI joinUnsafe(String suffix)
```
    Append additional path elements to the end of an AlluxioURI. This does not check if the new path needs normalization, and is less CPU intensive than join(String).
    
    Parameters:
    
    suffix - the suffix to add
    
    Returns:
    
    the new AlluxioURI
  - normalizePath
```
public static String normalizePath(String path)
```
    Normalize the path component of the AlluxioURI, by replacing all "//" and "\\" with "/", and trimming trailing slash from non-root path (ignoring windows drive).
    
    Parameters:
    
    path - the path to normalize
    
    Returns:
    
    the normalized path
  - isAncestorOf
```
public boolean isAncestorOf(AlluxioURI alluxioURI)
                     throws InvalidPathException
```
    Returns true if the current AlluxioURI is an ancestor of another AlluxioURI. otherwise, return false.
    
    Parameters:
    
    alluxioURI - potential children to check
    
    Returns:
    
    true the current alluxioURI is an ancestor of the AlluxioURI
    
    Throws:
    
    InvalidPathException
  - toString
```
public String toString()
```
    Illegal characters unescaped in the string, for glob processing, etc.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the String representation of the AlluxioURI
  - hash
```
public String hash()
```
    Computes the hash of this URI, with SHA-256, or MD5, or simple hashCode().
    
    Returns:
    
    HEX encoded hash string
  - hash
```
public static String hash(String uri)
```
    Computes the hash of this URI, with SHA-256, or MD5, or simple hashCode().
    
    Parameters:
    
    uri - the alluxio path uri
    
    Returns:
    
    HEX encoded hash string

Class AlluxioURI

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SEPARATOR

CUR_DIR

WILDCARD

EMPTY_URI

Constructor Detail

AlluxioURI

AlluxioURI

AlluxioURI

AlluxioURI

AlluxioURI

Method Detail

compareTo

equals

getAuthority

getDepth

getLeadingPath

containsWildcard

getName

getParent

getPath

getQueryMap

getScheme

getRootPath

hasAuthority

hashCode

hasScheme

hasWindowsDrive

isAbsolute

isPathAbsolute

isRoot

join

join

joinUnsafe

normalizePath

isAncestorOf

toString

hash

hash