org.apache.myfaces.custom.tree.model
Class TreePath

java.lang.Object
  org.apache.myfaces.custom.tree.model.TreePath

All Implemented Interfaces:

Serializable

public final class TreePath
extends Object
implements Serializable

Version:

$Revision: 472638 $ $Date: 2006-11-08 15:54:13 -0500 (Wed, 08 Nov 2006) $

Author:

Oliver Rossmueller

See Also:

Serialized Form

Constructor Summary

	TreePath(Object[] pathElements) Construct a pathElements from an array of Objects
protected	TreePath(Object[] pathElements, int length) Construct a new TreePath 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.

Method Summary

boolean	equals(Object o) Test two TreePaths for equality by checking each element of the paths for equality.
Object	getLastPathComponent() Returns the last component of this path.
TreePath	getParentPath() 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.
Object	getPathComponent(int index) Return the path component at the specified index.
int	getPathCount() Return the number of elements in the path.
int	hashCode() Return the hashCode for the object.
boolean	isDescendant(TreePath path) Return true if path is a descendant of this TreePath.
TreePath	pathByAddingChild(Object child) Return a new path by appending child to this path.
String	toString() Return a string that displays and identifies this object's properties.

Methods inherited from class java.lang.Object

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

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

getPath

public Object[] getPath()

Return an array of Objects containing the components of this TreePath.

Returns:

an array of Objects representing the TreePath

getLastPathComponent

public Object getLastPathComponent()

Returns the last component of this path.

Returns:

the Object at the end 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

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

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.

Overrides:

equals in class Object

Parameters:

o - the Object to compare

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.

Overrides:

hashCode in class Object

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

getParentPath

public TreePath getParentPath()

Return a path containing all the elements of this object, except the last path component.

toString

public String toString()

Return a string that displays and identifies this object's properties.

Overrides:

toString in class Object

Returns:

a String representation of this object