Module com.aoapps.net.types

Package com.aoapps.net

Class Path

java.lang.Object

com.aoapps.net.Path

All Implemented Interfaces:

DtoFactory<Path>, Internable<Path>, Serializable, Comparable<Path>

public final class Path
extends Object
implements Comparable<Path>, Serializable, DtoFactory<Path>, Internable<Path>

Represents a full path. Paths must:

• Be non-null
• Be non-empty
• Start with a /
• Not contain any null characters
• Not contain any /../ or /./ path elements
• Not end with /.. or /.
• Not contain any // in the path

Note, this concept of path is minimally restrictive and only represents a well-formed path. The path may not be valid for some contexts, such as the path part of a URL. This does not implement RFC 3986.

TODO: Should we disallow any number path element that is all dots, such as "...." and not just "." and ".."?

TODO: This matches UnixPath in aoserv-client with the exception of allowing trailing slash. Remove this redundancy?

Author:

AO Industries, Inc.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final Path	ROOT	The root path "/".
static final char	SEPARATOR_CHAR	The path separator as a char '/'.
static final String	SEPARATOR_STRING	The path separator as a single-character String "/".

Method Summary

Modifier and Type	Method	Description
int	compareTo(Path other)
boolean	equals(Object obj)
Path	getDto()
int	hashCode()
Path	intern()	Interns this path much in the same fashion as String.intern().
Path	prefix(int len)	Gets a prefix path of the given length.
Path	subPath(int beginIndex, int endIndex)	Gets a sub path of the given beginning and end.
Path	suffix(int beginIndex)	Gets a suffix path starting at the given index.
String	toString()
static ValidationResult	validate(String path)
static Path	valueOf(String path)

Methods inherited from class java.lang.Object

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

Field Details

SEPARATOR_CHAR

public static final char SEPARATOR_CHAR

The path separator as a char '/'.

See Also:

• Constant Field Values

SEPARATOR_STRING

public static final String SEPARATOR_STRING

The path separator as a single-character String "/".

ROOT

public static final Path ROOT

The root path "/". This is implemented as a singleton as is safe for direct object equality check "== ".

Method Details

validate

public static ValidationResult validate(String path)

valueOf

public static Path valueOf(String path)
                    throws ValidationException

Parameters:

path - when null, returns null

Throws:

ValidationException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(Path other)

Specified by:

compareTo in interface Comparable<Path>

toString

public String toString()

Overrides:

toString in class Object

intern

public Path intern()

Interns this path much in the same fashion as String.intern().

Specified by:

intern in interface Internable<Path>

See Also:

• String.intern()

getDto

public Path getDto()

Specified by:

getDto in interface DtoFactory<Path>

subPath

public Path subPath(int beginIndex,
 int endIndex)
             throws IllegalArgumentException,
IndexOutOfBoundsException

Gets a sub path of the given beginning and end.

Parameters:

beginIndex - Must align with a SEPARATOR_CHAR.

endIndex - One-past the last character to include. Must be greater than beginIndex.

Throws:

IllegalArgumentException

IndexOutOfBoundsException

See Also:

• String.substring(int, int)

prefix

public Path prefix(int len)
            throws IllegalArgumentException,
IndexOutOfBoundsException

Gets a prefix path of the given length.

Implementation Note:
Calls subPath(0, len)

Parameters:

len - Must be greater than 0.

Throws:

IllegalArgumentException

IndexOutOfBoundsException

See Also:

• subPath(int, int)

suffix

public Path suffix(int beginIndex)
            throws IllegalArgumentException,
IndexOutOfBoundsException

Gets a suffix path starting at the given index.

Implementation Note:
Calls subPath(beginIndex, path.length())

Parameters:

beginIndex - Must align with a SEPARATOR_CHAR.

Throws:

IllegalArgumentException

IndexOutOfBoundsException

See Also:

• subPath(int, int)