com.asakusafw.operation.tools.directio

Class BasePath

java.lang.Object

com.asakusafw.operation.tools.directio.BasePath

public class BasePath
extends Object

Represents a base path of Direct I/O.

Since:

0.10.0

Field Summary

Fields

Modifier and Type	Field and Description
static BasePath	EMPTY The empty path.

Method Summary

Modifier and Type	Method and Description
FilePattern	asFilePattern() Returns the file pattern.
boolean	equals(Object obj)
String	getPathString() Returns the path string.
List<String>	getSegments() Returns the path segments.
int	hashCode()
static BasePath	headOf(String path) Extracts a base path from the given path.
static boolean	isEmpty(String path) Returns whether or not the given path is empty.
boolean	isPrefixOf(BasePath other) Returns whether or not this path is a prefix of the given path.
boolean	isRoot() Returns whether this represents the root path.
static BasePath	of(String path) Resolves the given path.
static Optional<BasePath>	parse(String path) Resolves the given path.
BasePath	relativise(BasePath other) Returns the relative path of the given path.
BasePath	resolve(BasePath other) Returns a base path that is concatenation of this and the given path.
FilePattern	resolve(FilePattern pattern) Returns a file pattern that is a sequence of this and the given pattern.
Optional<FilePattern>	restOf(String path) Extracts the rest resource pattern of the given path.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final BasePath EMPTY

The empty path.

Method Detail

isEmpty

public static boolean isEmpty(String path)

Returns whether or not the given path is empty.

Parameters:

path - the path

Returns:

true if it is empty

parse

public static Optional<BasePath> parse(String path)

Resolves the given path.

Parameters:

path - the given path

Returns:

the base path, or empty if it is not a valid base path

of

public static BasePath of(String path)

Resolves the given path.

Parameters:

path - the given path

Returns:

the base path

headOf

public static BasePath headOf(String path)

Extracts a base path from the given path.

Parameters:

path - the given path

Returns:

the base path of the given path

isRoot

public boolean isRoot()

Returns whether this represents the root path.

Returns:

true if this represents the root path

getSegments

public List<String> getSegments()

Returns the path segments.

Returns:

the path segments

isPrefixOf

public boolean isPrefixOf(BasePath other)

Returns whether or not this path is a prefix of the given path.

Parameters:

other - the target path

Returns:

true if this path is a prefix of the given path, otherwise false

restOf

public Optional<FilePattern> restOf(String path)

Extracts the rest resource pattern of the given path.

Parameters:

path - the target path

Returns:

the rest resource pattern

See Also:

headOf(String)

relativise

public BasePath relativise(BasePath other)

Returns the relative path of the given path.

Parameters:

other - the target path

Returns:

the relative path

resolve

public FilePattern resolve(FilePattern pattern)

Returns a file pattern that is a sequence of this and the given pattern.

Parameters:

pattern - the target pattern

Returns:

the resolved pattern

resolve

public BasePath resolve(BasePath other)

Returns a base path that is concatenation of this and the given path.

Parameters:

other - the suffix path

Returns:

the resolved path

getPathString

public String getPathString()

Returns the path string.

Returns:

the path string, or an empty string if it represents the root

asFilePattern

public FilePattern asFilePattern()

Returns the file pattern.

Returns:

the file pattern

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object