io.delta.kernel.internal.fs

Class Path

java.lang.Object

io.delta.kernel.internal.fs.Path

All Implemented Interfaces:

java.io.ObjectInputValidation, java.io.Serializable, java.lang.Comparable<Path>

public class Path
extends java.lang.Object
implements java.lang.Comparable<Path>, java.io.Serializable, java.io.ObjectInputValidation

Names a file or directory in a FileSystem. Path strings use slash as the directory separator. Taken from https://github.com/apache/hadoop/blob/branch-3.3.4/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/Path.java TODO: remove unused parts

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CUR_DIR The current directory, ".".
static java.lang.String	SEPARATOR The directory separator, a slash.
static char	SEPARATOR_CHAR The directory separator, a slash, as a character.
static boolean	WINDOWS Whether the current host is a Windows machine.

Constructor Summary

Constructors

Constructor and Description
Path(Path parent, Path child) Create a new Path based on the child path resolved against the parent path.
Path(Path parent, java.lang.String child) Create a new Path based on the child path resolved against the parent path.
Path(java.lang.String pathString) Construct a path from a String.
Path(java.lang.String parent, Path child) Create a new Path based on the child path resolved against the parent path.
Path(java.lang.String parent, java.lang.String child) Create a new Path based on the child path resolved against the parent path.
Path(java.lang.String scheme, java.lang.String authority, java.lang.String path) Construct a Path from components.
Path(java.net.URI aUri) Construct a path from a URI

Method Summary

Modifier and Type	Method and Description
int	compareTo(Path o)
int	depth() Returns the number of elements in this path.
boolean	equals(java.lang.Object o)
java.lang.String	getName() Returns the final component of this path.
static java.lang.String	getName(java.lang.String pathString)
Path	getParent() Returns the parent of a path or null if at root.
static Path	getPathWithoutSchemeAndAuthority(Path path) Return a version of the given Path without the scheme information.
int	hashCode()
boolean	isAbsolute() Returns true if the path component (i.e.
boolean	isAbsoluteAndSchemeAuthorityNull() Returns true if the path component (i.e.
boolean	isRoot() Returns true if and only if this path represents the root of a file system.
boolean	isUriPathAbsolute() Returns true if the path component (i.e.
static boolean	isWindowsAbsolutePath(java.lang.String pathString, boolean slashed) Determine whether a given path string represents an absolute path on Windows.
Path	makeQualified(java.net.URI defaultUri, Path workingDir) Returns a qualified path object.
static Path	mergePaths(Path path1, Path path2) Merge 2 paths such that the second path is appended relative to the first.
Path	suffix(java.lang.String suffix) Adds a suffix to the final name in the path.
java.lang.String	toString()
java.net.URI	toUri() Convert this Path to a URI.
void	validateObject() Validate the contents of a deserialized Path, so as to defend against malicious object streams.

Methods inherited from class java.lang.Object

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

Field Detail

SEPARATOR

public static final java.lang.String SEPARATOR

The directory separator, a slash.

See Also:

Constant Field Values

SEPARATOR_CHAR

public static final char SEPARATOR_CHAR

The directory separator, a slash, as a character.

See Also:

Constant Field Values

CUR_DIR

public static final java.lang.String CUR_DIR

The current directory, ".".

See Also:

Constant Field Values

WINDOWS

public static final boolean WINDOWS

Whether the current host is a Windows machine.

Constructor Detail

Path

public Path(java.lang.String parent,
            java.lang.String child)

Create a new Path based on the child path resolved against the parent path.

Parameters:

parent - the parent path

child - the child path

Path

public Path(Path parent,
            java.lang.String child)

Create a new Path based on the child path resolved against the parent path.

Parameters:

parent - the parent path

child - the child path

Path

public Path(java.lang.String parent,
            Path child)

Create a new Path based on the child path resolved against the parent path.

Parameters:

parent - the parent path

child - the child path

Path

public Path(Path parent,
            Path child)

Create a new Path based on the child path resolved against the parent path.

Parameters:

parent - the parent path

child - the child path

Path

public Path(java.lang.String pathString)
     throws java.lang.IllegalArgumentException

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

Parameters:

pathString - the path string

Throws:

java.lang.IllegalArgumentException

Path

public Path(java.net.URI aUri)

Construct a path from a URI

Parameters:

aUri - the source URI

Path

public Path(java.lang.String scheme,
            java.lang.String authority,
            java.lang.String path)

Construct a Path from components.

Parameters:

scheme - the scheme

authority - the authority

path - the path

Method Detail

getPathWithoutSchemeAndAuthority

public static Path getPathWithoutSchemeAndAuthority(Path path)

Return a version of the given Path without the scheme information.

Parameters:

path - the source Path

Returns:

a copy of this Path without the scheme information

mergePaths

public static Path mergePaths(Path path1,
                              Path path2)

Merge 2 paths such that the second path is appended relative to the first. The returned path has the scheme and authority of the first path. On Windows, the drive specification in the second path is discarded.

Parameters:

path1 - the first path

path2 - the second path, to be appended relative to path1

Returns:

the merged path

isWindowsAbsolutePath

public static boolean isWindowsAbsolutePath(java.lang.String pathString,
                                            boolean slashed)

Determine whether a given path string represents an absolute path on Windows. e.g. "C:/a/b" is an absolute path. "C:a/b" is not.

Parameters:

pathString - the path string to evaluate

slashed - true if the given path is prefixed with "/"

Returns:

true if the supplied path looks like an absolute path with a Windows drive-specifier

toUri

public java.net.URI toUri()

Convert this Path to a URI.

Returns:

this Path as a URI

isAbsoluteAndSchemeAuthorityNull

public boolean isAbsoluteAndSchemeAuthorityNull()

Returns true if the path component (i.e. directory) of this URI is absolute and the scheme is null, and the authority is null.

Returns:

whether the path is absolute and the URI has no scheme nor authority parts

isUriPathAbsolute

public boolean isUriPathAbsolute()

Returns true if the path component (i.e. directory) of this URI is absolute.

Returns:

whether this URI's path is absolute

isAbsolute

public boolean isAbsolute()

Returns true if the path component (i.e. directory) of this URI is absolute. This method is a wrapper for isUriPathAbsolute().

Returns:

whether this URI's path is absolute

isRoot

public boolean isRoot()

Returns true if and only if this path represents the root of a file system.

Returns:

true if and only if this path represents the root of a file system

getName

public java.lang.String getName()

Returns the final component of this path.

Returns:

the final component of this path

getParent

public Path getParent()

Returns the parent of a path or null if at root.

Returns:

the parent of a path or null if at root

suffix

public Path suffix(java.lang.String suffix)

Adds a suffix to the final name in the path.

Parameters:

suffix - the suffix to add

Returns:

a new path with the suffix added

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(Path o)

Specified by:

compareTo in interface java.lang.Comparable<Path>

depth

public int depth()

Returns the number of elements in this path.

Returns:

the number of elements in this path

makeQualified

public Path makeQualified(java.net.URI defaultUri,
                          Path workingDir)

Returns a qualified path object.

Parameters:

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

workingDir - if this path isn't absolute, treat it as relative to this working directory

Returns:

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

validateObject

public void validateObject()
                    throws java.io.InvalidObjectException

Validate the contents of a deserialized Path, so as to defend against malicious object streams.

Specified by:

validateObject in interface java.io.ObjectInputValidation

Throws:

java.io.InvalidObjectException - if there's no URI

getName

public static java.lang.String getName(java.lang.String pathString)