Package org.eclipse.jface.viewers
Class TreeNode
- java.lang.Object
-
- org.eclipse.jface.viewers.TreeNode
-
public class TreeNode extends Object
A simple data structure that is useful for implemented tree models. This can be returned byIStructuredContentProvider.getElements(Object)
. It allows simple delegation of methods fromITreeContentProvider
such asITreeContentProvider.getChildren(Object)
,ITreeContentProvider.getParent(Object)
andITreeContentProvider.hasChildren(Object)
- Since:
- 3.2
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object object)
TreeNode[]
getChildren()
Returns the child nodes.TreeNode
getParent()
Returns the parent node.Object
getValue()
Returns the value held by this node.boolean
hasChildren()
Returns whether the tree has any children.int
hashCode()
void
setChildren(TreeNode[] children)
Sets the children for this node.void
setParent(TreeNode parent)
Sets the parent for this node.
-
-
-
Field Detail
-
value
protected Object value
The value contained in this node. This value may be anything.
-
-
Constructor Detail
-
TreeNode
public TreeNode(Object value)
Constructs a new instance ofTreeNode
.- Parameters:
value
- The value held by this node; may be anything.
-
-
Method Detail
-
getChildren
public TreeNode[] getChildren()
Returns the child nodes. Empty arrays are converted tonull
before being returned.- Returns:
- The child nodes; may be
null
, but never empty. There should be nonull
children in the array.
-
getParent
public TreeNode getParent()
Returns the parent node.- Returns:
- The parent node; may be
null
if there are no parent nodes.
-
getValue
public Object getValue()
Returns the value held by this node.- Returns:
- The value; may be anything.
-
hasChildren
public boolean hasChildren()
Returns whether the tree has any children.- Returns:
true
if its array of children is notnull
and is non-empty;false
otherwise.
-
setChildren
public void setChildren(TreeNode[] children)
Sets the children for this node.- Parameters:
children
- The child nodes; may benull
or empty. There should be nonull
children in the array.
-
setParent
public void setParent(TreeNode parent)
Sets the parent for this node.- Parameters:
parent
- The parent node; may benull
.
-
-