org.apache.myfaces.custom.tree.model

Class TreePath

public final class TreePath extends Object implements Serializable

Version: $Revision: 225368 $ $Date: 2005-07-26 20:14:51 +0200 (Tue, 26 Jul 2005) $

Author: Oliver Rossmueller

Constructor Summary
TreePath(Object[] pathElements)
Construct a pathElements from an array of Objects
protected TreePath(TreePath parent, Object lastElement)
Construct a new TreePath, which is the path identified by parent ending in lastElement.
protected TreePath(Object[] pathElements, int length)
Construct a new TreePath from an array of objects.
Method Summary
booleanequals(Object o)
Test two TreePaths for equality by checking each element of the paths for equality.
ObjectgetLastPathComponent()
Returns the last component of this path.
TreePathgetParentPath()
Return a path containing all the elements of this object, except the last path component.
Object[]getPath()
Return an array of Objects containing the components of this TreePath.
ObjectgetPathComponent(int index)
Return the path component at the specified index.
intgetPathCount()
Return the number of elements in the path.
inthashCode()
Return the hashCode for the object.
booleanisDescendant(TreePath path)
Return true if path is a descendant of this TreePath.
TreePathpathByAddingChild(Object child)
Return a new path by appending child to this path.
StringtoString()
Return a string that displays and identifies this object's properties.

Constructor Detail

TreePath

public TreePath(Object[] pathElements)
Construct a pathElements from an array of Objects

Parameters: pathElements an array of Objects representing the pathElements to a node

TreePath

protected TreePath(TreePath parent, Object lastElement)
Construct a new TreePath, which is the path identified by parent ending in lastElement.

TreePath

protected TreePath(Object[] pathElements, int length)
Construct a new TreePath from an array of objects.

Parameters: pathElements path elements length lenght of the new path

Method Detail

equals

public boolean equals(Object o)
Test two TreePaths for equality by checking each element of the paths for equality. Two paths are considered equal if they are of the same length and all element positions are equal.

Parameters: o the Object to compare

getLastPathComponent

public Object getLastPathComponent()
Returns the last component of this path.

Returns: the Object at the end of the path

getParentPath

public TreePath getParentPath()
Return a path containing all the elements of this object, except the last path component.

getPath

public Object[] getPath()
Return an array of Objects containing the components of this TreePath.

Returns: an array of Objects representing the TreePath

getPathComponent

public Object getPathComponent(int index)
Return the path component at the specified index.

Parameters: index int specifying an index in the path

Returns: the Object at that index location

Throws: IllegalArgumentException if the index is beyond the length of the path

getPathCount

public int getPathCount()
Return the number of elements in the path.

Returns: an int giving a count of items the path

hashCode

public int hashCode()
Return the hashCode for the object. The hash code of a TreePath is defined to be the hash code of the last component in the path.

Returns: the hashCode for the object

isDescendant

public boolean isDescendant(TreePath path)
Return true if path is a descendant of this TreePath. A TreePath P1 is a descendent of a TreePath P2 if P1 contains all of the components that make up P2's path. If P1 and P2 are equal P2 is not considered a descendant of P1.

Returns: true if path is a descendant of this path

pathByAddingChild

public TreePath pathByAddingChild(Object child)
Return a new path by appending child to this path.

Parameters: child element to append

Returns: new path

Throws: NullPointerException if child is null

toString

public String toString()
Return a string that displays and identifies this object's properties.

Returns: a String representation of this object