TreePath JDK 1.6)

Description

public class TreePath

Represents a path to a node.

See also:

Constructors

protected TreePath ()

Primarily provided for subclasses that represent paths in a different manner.

Primarily provided for subclasses
that represent paths in a different manner.
If a subclass uses this constructor, it should also override
the getPath,
getPathCount, and
getPathComponent methods,
and possibly the equals method.

public TreePath (Object singlePath)

Constructs a TreePath containing only a single element.

public TreePath (Object path)

Constructs a path from an array of Objects, uniquely identifying the path from the root of the tree to a specific node, as returned by the tree's data model.

protected TreePath (Object path, int length)

Constructs a new TreePath with the identified path components of length length.

protected TreePath (TreePath parent, Object lastElement)

Constructs a new TreePath, which is the path identified by parent ending in lastElement.

Methods

Hide/Show inherited methods

public boolean equals (Object o)

Tests two TreePaths for equality by checking each element of the paths for equality.

Tests 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 contain
the same elements (.equals).
Parameters:
- o - the Object to compare

public Object getLastPathComponent ()

Returns the last component of this path.

public TreePath getParentPath ()

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

public Object getPath ()

Returns an ordered array of Objects containing the components of this TreePath.

public Object getPathComponent (int element)

Returns the path component at the specified index.

public int getPathCount ()

Returns the number of elements in the path.

public int hashCode ()

Returns the hashCode for the object.

public boolean isDescendant (TreePath aTreePath)

Returns true if aTreePath is a descendant of this TreePath.

Returns true if aTreePath is a
descendant of this
TreePath. A TreePath P1 is a descendant of a TreePath P2
if P1 contains all of the components that make up
P2's path.
For example, if this object has the path [a, b],
and aTreePath has the path [a, b, c],
then aTreePath is a descendant of this object.
However, if aTreePath has the path [a],
then it is not a descendant of this object. By this definition
a TreePath is always considered a descendant of itself. That is,
aTreePath.isDescendant(aTreePath) returns true.
Returns: true if aTreePath is a descendant of this path

public TreePath pathByAddingChild (Object child)

Returns a new path containing all the elements of this object plus child.

Returns a new path containing all the elements of this object
plus child. child will be the last element
of the newly created TreePath.
This will throw a NullPointerException
if child is null.

public String toString ()

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