org.apache.hudi.storage

Class StoragePath

java.lang.Object

org.apache.hudi.storage.StoragePath

All Implemented Interfaces:

Serializable, Comparable<StoragePath>

@PublicAPIClass(maturity=EVOLVING)
public class StoragePath
extends Object
implements Comparable<StoragePath>, Serializable

Names a file or directory on storage. Path strings use slash (`/`) as the directory separator. The APIs are mainly based on org.apache.hadoop.fs.Path class.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static char	COLON_CHAR
static String	SEPARATOR
static char	SEPARATOR_CHAR

Constructor Summary

Constructors

Constructor and Description
StoragePath(StoragePath parent, String child)
StoragePath(String path)
StoragePath(String parent, String child)
StoragePath(URI uri)

Method Summary

Modifier and Type	Method and Description
int	compareTo(StoragePath o)
int	depth()
boolean	equals(Object o)
String	getFileExtension()
String	getName()
StoragePath	getParent()
StoragePath	getPathWithoutSchemeAndAuthority()
int	hashCode()
boolean	isAbsolute()
StoragePath	makeQualified(URI defaultUri) Returns a qualified path object.
String	toString()
URI	toUri()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SEPARATOR_CHAR

public static final char SEPARATOR_CHAR

See Also:

Constant Field Values

COLON_CHAR

public static final char COLON_CHAR

See Also:

Constant Field Values

SEPARATOR

public static final String SEPARATOR

See Also:

Constant Field Values

Constructor Detail

StoragePath

public StoragePath(URI uri)

StoragePath

public StoragePath(String path)

StoragePath

public StoragePath(String parent,
                   String child)

StoragePath

public StoragePath(StoragePath parent,
                   String child)

Method Detail

isAbsolute

@PublicAPIMethod(maturity=EVOLVING)
public boolean isAbsolute()

getParent

@PublicAPIMethod(maturity=EVOLVING)
public StoragePath getParent()

getName

@PublicAPIMethod(maturity=EVOLVING)
public String getName()

getPathWithoutSchemeAndAuthority

@PublicAPIMethod(maturity=EVOLVING)
public StoragePath getPathWithoutSchemeAndAuthority()

depth

@PublicAPIMethod(maturity=EVOLVING)
public int depth()

toUri

@PublicAPIMethod(maturity=EVOLVING)
public URI toUri()

makeQualified

@PublicAPIMethod(maturity=EVOLVING)
public StoragePath makeQualified(URI defaultUri)

Returns a qualified path object.

Parameters:

defaultUri - if this path is missing the scheme or authority components, borrow them from this URI.

Returns:

this path if it contains a scheme and authority, or a new path that includes a path and authority and is fully qualified.

getFileExtension

@PublicAPIMethod(maturity=EVOLVING)
public String getFileExtension()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(StoragePath o)

Specified by:

compareTo in interface Comparable<StoragePath>