jsimple.util

Class TextualPath

java.lang.Object

jsimple.util.TextualPath

public class TextualPath
extends java.lang.Object

A TextualPath abstracts any path-like structure that can be represented as a list of strings. It can be used for paths in a file system, a URL path, an XPath path, etc. Implementation wise, it's simply a list of 0 or move strings.

Unlike the standard Java Path class: This isn't just for file system paths and "." and ".." have no special meaning. A TextualPath has no concept of being absolute or relative; it's simplest to think about it as always being absolute and toString represents it that way (with a leading "/"), but if the caller wants to treat it as a relative path it can do that. Also, "/abc" and "/abc/" have the same representation in a TextualPath--they both are a list with one element, "abc", which toString will return as "/abc".

Since:

8/16/13 9:55 PM

Constructor Summary

Constructors

Constructor and Description
TextualPath() Create a TextualPath that's empty (that is, points to the root).
TextualPath(java.lang.String pathElement1) Create a TextualPath containing a single path element.
TextualPath(java.lang.String pathElement1, java.lang.String pathElement2)
TextualPath(java.lang.String pathElement1, java.lang.String pathElement2, java.lang.String pathElement3)
TextualPath(TextualPath parent, java.lang.String child) Create a TextualPath that's the same as parent path, except with the new child added at the end.

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String pathElement)
boolean	equals(java.lang.Object o)
java.lang.String	getFirstElement()
java.lang.String	getLastElement()
int	getLength() Get the length of the path, the number of path elements contained in it.
TextualPath	getParent() Get the parent of this path, containing all elements except the last.
ArrayList<java.lang.String>	getPathElements()
int	hashCode()
boolean	isEmpty() Check if the path is empty, having no elements.
boolean	startsWith(TextualPath prefixPath) See if this path starts with another path.
java.lang.String	toString() Get a human friendly string representation of the path, using / as the delimiter.

Methods inherited from class java.lang.Object

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

Constructor Detail

TextualPath

public TextualPath()

Create a TextualPath that's empty (that is, points to the root).

TextualPath

public TextualPath(java.lang.String pathElement1)

Create a TextualPath containing a single path element.

Parameters:

pathElement1 -

TextualPath

public TextualPath(java.lang.String pathElement1,
                   java.lang.String pathElement2)

TextualPath

public TextualPath(java.lang.String pathElement1,
                   java.lang.String pathElement2,
                   java.lang.String pathElement3)

TextualPath

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

Create a TextualPath that's the same as parent path, except with the new child added at the end.

Parameters:

parent - parent path

child - child element to add at end

Method Detail

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

add

public void add(java.lang.String pathElement)

startsWith

public boolean startsWith(TextualPath prefixPath)

See if this path starts with another path.

Parameters:

prefixPath - path that potentially is at beginning of this path

Returns:

true if this the beginning elements of this path match prefixPath or if the two paths are the same

getLength

public int getLength()

Get the length of the path, the number of path elements contained in it.

Returns:

path length, which is >= 0

isEmpty

public boolean isEmpty()

Check if the path is empty, having no elements. This can be thought of as pointing to the root of the tree.

Returns:

true if path has no elements

getParent

public TextualPath getParent()

Get the parent of this path, containing all elements except the last. If the path is empty and thus has no parent, an exception is thrown.

Returns:

parent of this path

getPathElements

public ArrayList<java.lang.String> getPathElements()

getFirstElement

public java.lang.String getFirstElement()

getLastElement

public java.lang.String getLastElement()

toString

public java.lang.String toString()

Get a human friendly string representation of the path, using / as the delimiter. Note that no escaping is done of special characters (space, slash, etc.), so this string often isn't appropriate for programmatic use.

Overrides:

toString in class java.lang.Object

Returns:

human friendly string representation of the path