tachyon.util.io

Class PathUtils

java.lang.Object

tachyon.util.io.PathUtils

public final class PathUtils
extends Object

Utilities related to both Tachyon paths like TachyonURI and local file paths.

Method Summary

Methods

Modifier and Type	Method and Description
static String	cleanPath(String path) Checks and normalizes the given path.
static String	concatPath(Object base, Object... paths) Joins each element in paths in order, separated by TachyonURI.SEPARATOR.
static String	getParent(String path) Gets the parent of the file at a path.
static String[]	getPathComponents(String path) Gets the path components of the given path.
static boolean	hasPrefix(String path, String prefix) Checks whether the given path contains the given prefix.
static boolean	isRoot(String path) Checks if the given path is the root.
static String	temporaryFileName(long fileId, long nonce, String path) Generates a deterministic temporary file name for the a path and a file id and a nonce.
static String	uniqPath() Creates a unique path based off the caller.
static void	validatePath(String path) Checks if the given path is properly formed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

cleanPath

public static String cleanPath(String path)
                        throws InvalidPathException

Checks and normalizes the given path.

Parameters:

path - The path to clean up

Returns:

a normalized version of the path, with single separators between path components and dot components resolved

Throws:

InvalidPathException - if the path is invalid

concatPath

public static String concatPath(Object base,
                Object... paths)
                         throws IllegalArgumentException

Joins each element in paths in order, separated by TachyonURI.SEPARATOR.

For example,

 concatPath("/myroot/", "dir", 1L, "filename").equals("/myroot/dir/1/filename");
 concatPath("tachyon://myroot", "dir", "filename").equals("tachyon://myroot/dir/filename");
 concatPath("myroot/", "/dir/", "filename").equals("myroot/dir/filename");
 concatPath("/", "dir", "filename").equals("/dir/filename");
 
 

Note that empty element in base or paths is ignored.

Parameters:

base - base path

paths - paths to concatenate

Returns:

joined path

Throws:

IllegalArgumentException - if base or paths is null

getParent

public static String getParent(String path)
                        throws InvalidPathException

Gets the parent of the file at a path.

Parameters:

path - The path

Returns:

the parent path of the file; this is "/" if the given path is the root

Throws:

InvalidPathException - if the path is invalid

getPathComponents

public static String[] getPathComponents(String path)
                                  throws InvalidPathException

Gets the path components of the given path.

Parameters:

path - The path to split

Returns:

the path split into components

Throws:

InvalidPathException - if the path is invalid

hasPrefix

public static boolean hasPrefix(String path,
                String prefix)
                         throws InvalidPathException

Checks whether the given path contains the given prefix. The comparison happens at a component granularity; for example, hasPrefix(/dir/file, /dir) should evaluate to true, while hasPrefix(/dir/file, /d) should evaluate to false.

Parameters:

path - a path

prefix - a prefix

Returns:

whether the given path has the given prefix

Throws:

InvalidPathException

isRoot

public static boolean isRoot(String path)
                      throws InvalidPathException

Checks if the given path is the root.

Parameters:

path - The path to check

Returns:

true if the path is the root

Throws:

InvalidPathException - if the path is invalid

validatePath

public static void validatePath(String path)
                         throws InvalidPathException

Checks if the given path is properly formed.

Parameters:

path - The path to check

Throws:

InvalidPathException - If the path is not properly formed

temporaryFileName

public static final String temporaryFileName(long fileId,
                       long nonce,
                       String path)

Generates a deterministic temporary file name for the a path and a file id and a nonce.

Parameters:

fileId - a file id

nonce - a nonce token

path - a file path

Returns:

a deterministic temporary file name

uniqPath

public static final String uniqPath()

Creates a unique path based off the caller.

Returns:

unique path based off the caller