org.apache.paimon.fs

Class Path

java.lang.Object

org.apache.paimon.fs.Path

All Implemented Interfaces:

Serializable, Comparable<Path>

@Public
public class Path
extends Object
implements Comparable<Path>, Serializable

Names a file or directory in a FileIO. Path strings use slash as the directory separator.

Since:

0.4.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CUR_DIR The current directory, ".".
static 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, String child) Create a new Path based on the child path resolved against the parent path.
Path(String pathString) Construct a path from a String.
Path(String parent, Path child) Create a new Path based on the child path resolved against the parent path.
Path(String parent, String child) Create a new Path based on the child path resolved against the parent path.
Path(String scheme, String authority, String path) Construct a Path from a scheme, an authority and a path string.
Path(URI aUri) Construct a path from a URI.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Path that)
Path	createTempPath() Create a temporary path (to be used as a copy) for this path.
boolean	equals(Object o)
String	getName() Returns the final component of this path, i.e., everything that follows the last separator.
Path	getParent() Returns the parent of a path or null if at root.
int	hashCode()
String	toString()
URI	toUri() Convert this Path to a URI.

Methods inherited from class java.lang.Object

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

Field Detail

SEPARATOR

public static final 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 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(String parent,
            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,
            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(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(String pathString)

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

Parameters:

pathString - the path string

Path

public Path(URI aUri)

Construct a path from a URI.

Parameters:

aUri - the source URI

Path

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

Construct a Path from a scheme, an authority and a path string.

Parameters:

scheme - the scheme

authority - the authority

path - the path

Method Detail

toUri

public URI toUri()

Convert this Path to a URI.

Returns:

this Path as a URI

getName

public String getName()

Returns the final component of this path, i.e., everything that follows the last separator.

Returns:

the final component of the path

createTempPath

public Path createTempPath()

Create a temporary path (to be used as a copy) for 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

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(Path that)

Specified by:

compareTo in interface Comparable<Path>