Package com.apptus.panel

Class Path

java.lang.Object

com.apptus.panel.Path

All Implemented Interfaces:

Comparable<Path>

public class Path
extends Object
implements Comparable<Path>

Convenience class for working with panel paths.

Author:

Thomas Raneland

Field Summary

Fields

Modifier and Type	Field	Description
protected String	path
static String	SEPARATOR

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Path(String path)

Method Summary

Modifier and Type	Method	Description
Path	ancestor(int length)	Returns the ancestor of length length of this path.
List<Path>	ancestors()	Returns all the ancestors to a path, starting with the closest.
Path	child(String name)	Returns a new path denoting a specified child element of the element denoted by this path.
int	compareTo(Path that)
Path	descendant(Path endpath)
Path	endpath(int start)	Returns an end path of this path.
boolean	equals(Object o)
boolean	hasAncestor(Path ancestor)
int	hashCode()
boolean	hasParent()
boolean	isRoot()
int	length()
Path	parent()	Returns a new path denoting the parent element of the element denoted by this path.
static Path	parse(String path)	Parses the path supplied as a string and returns a Path object representing the same path.
static Path	root()
String	simpleName()	Returns the simple name of the element denoted by this path.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SEPARATOR

public static final String SEPARATOR

See Also:

Constant Field Values

path

protected final String path

Constructor Detail

Path

protected Path(String path)

Method Detail

root

public static Path root()

Returns:

a path denoting the root, "/".

parse

public static Path parse(String path)

Parses the path supplied as a string and returns a Path object representing the same path.

Parameters:

path - path to parse

Returns:

a Path object representing the path

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

compareTo

public int compareTo(Path that)

Specified by:

compareTo in interface Comparable<Path>

child

public Path child(String name)

Returns a new path denoting a specified child element of the element denoted by this path.

For instance, Path.parse("/an/example/").child("child") is equal to Path.parse("/an/example/child").

Parameters:

name - The name of the child element

Returns:

A new path denoting the child element

parent

public Path parent()

Returns a new path denoting the parent element of the element denoted by this path.

For instance, Path.parse("/an/example/").parent() is equal to Path.parse("/an").

Returns:

A new path denoting the parent element

ancestors

public List<Path> ancestors()

Returns all the ancestors to a path, starting with the closest.

For instance, Path.parse("/an/example/path") will return a list containing the paths: "/an/example", "/an" and "/" in that order.

Returns:

A list of ancestor paths.

simpleName

public String simpleName()

Returns the simple name of the element denoted by this path.

For instance, Path.parse("/an/example").simpleName() becomes "example".

Returns:

simple name of element

isRoot

public boolean isRoot()

Returns:

True if this path denotes the root "/", false otherwise.

hasParent

public boolean hasParent()

Returns:

True if this path has a parent path.

length

public int length()

Returns:

the number of components in this path. The root (/) has length 1.

ancestor

public Path ancestor(int length)

Returns the ancestor of length length of this path. For instance, Path.parse("/a/b/c/d").ancestor(3) returns /a/b, since /a/b is the ancestor of /a/b/c/d with length 3.

Parameters:

length - ancestor length

Returns:

ancestor of length

endpath

public Path endpath(int start)

Returns an end path of this path. For instance, Path.parse("/a/b/c/d").endpath(2) returns the relative path b/c/d, since the prefix /a of length 2 is cut.

Parameters:

start - prefix length

Returns:

relative end path based on start

descendant

public Path descendant(Path endpath)

Parameters:

endpath - path to append.

Returns:

a descendant of this path. For instance, Path.parse("/a/b").descendant("c/d") returns the path /a/b/c/d.

hasAncestor

public boolean hasAncestor(Path ancestor)

Parameters:

ancestor - a potential ancestor that you want to evaluate.

Returns:

true if this path has an ancestor as specified by the ancestor argument, or if this path equals ancestor. Otherwise, returns false. For instance, Path.parse("/a/b/c").hasAncestor(Path.parse("/a")) and Path.parse("/a/b/c").hasAncestor(Path.parse("/a/b/c")) returns true, while Path.parse("/a/b").hasAncestor("/c") returns false.