de.alpharogroup.tree

Class TreeNode<T>

java.lang.Object

de.alpharogroup.tree.TreeNode<T>

Type Parameters:

T - the generic type

All Implemented Interfaces:

ITreeNode<T>, Serializable

public class TreeNode<T>
extends Object
implements ITreeNode<T>

The generic class TreeNode.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TreeNode() Instantiates a new tree node.
TreeNode(T value) Instantiates a new tree node.

Method Summary

Modifier and Type	Method and Description
void	addChild(ITreeNode<T> child) Adds the child.
void	addChildAt(int index, ITreeNode<T> child) Adds the child.
boolean	equals(ITreeNode<T> treeNode) Equals.
List<ITreeNode<T>>	getAllSiblings() Returns all siblings of this node in the parent's children list.
int	getChildCount() Gets the child count.
List<ITreeNode<T>>	getChildren() Gets the children.
int	getDepth() Returns the depth of the tree beginning at this node Returns 0 if this node has no children.
String	getDisplayValue() Gets the optional display value.
int	getLevel() Returns the distance from the root to this node.
ITreeNode<T>	getNextSibling() Returns the next sibling of this node in the parent's children list.
ITreeNode<T>	getParent() Gets the parent.
ITreeNode<T>	getPreviousSibling() Returns the previous sibling of this node in the parent's children list.
T	getValue() Gets the value.
boolean	hasChildren() Checks for children.
int	hashCode()
boolean	hasParent() Checks for parent.
boolean	isLeaf() Checks if is leaf.
boolean	isNode() Checks if is node.
boolean	isRoot() Checks if this treenode is root.
void	removeChild(ITreeNode<T> child) Removes the child.
void	removeChildAt(int index) Removes the child.
void	setChildren(List<ITreeNode<T>> children) Sets the children.
void	setDisplayValue(String displayValue) Sets the optional display value.
void	setParent(ITreeNode<T> parent) Sets the parent.
void	setValue(T value) Sets the value.
List<ITreeNode<T>>	toList() To list.
void	traverse(ITreeNode<T> node, List<ITreeNode<T>> list) Traverse.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TreeNode

public TreeNode()

Instantiates a new tree node.

TreeNode

public TreeNode(T value)

Instantiates a new tree node.

Parameters:

value - the value

Method Detail

addChild

public void addChild(ITreeNode<T> child)

Adds the child.

Specified by:

addChild in interface ITreeNode<T>

Parameters:

child - the child

addChildAt

public void addChildAt(int index,
                       ITreeNode<T> child)
                throws IndexOutOfBoundsException

Adds the child.

Specified by:

addChildAt in interface ITreeNode<T>

Parameters:

index - the index

child - the child

Throws:

IndexOutOfBoundsException - the index out of bounds exception

equals

public boolean equals(ITreeNode<T> treeNode)

Equals.

Specified by:

equals in interface ITreeNode<T>

Parameters:

treeNode - the tree node

Returns:

true, if successful

getAllSiblings

public List<ITreeNode<T>> getAllSiblings()

Returns all siblings of this node in the parent's children list. Returns null if this node is the root.

Specified by:

getAllSiblings in interface ITreeNode<T>

Returns:

Returns all siblings of this node or null if this node is the root.

getChildCount

public int getChildCount()

Gets the child count.

Specified by:

getChildCount in interface ITreeNode<T>

Returns:

the child count

getChildren

public List<ITreeNode<T>> getChildren()

Gets the children.

Specified by:

getChildren in interface ITreeNode<T>

Returns:

the children

getDepth

public int getDepth()

Returns the depth of the tree beginning at this node Returns 0 if this node has no children.

Specified by:

getDepth in interface ITreeNode<T>

Returns:

the depth of the tree beginning at this node.

getDisplayValue

public String getDisplayValue()

Gets the optional display value.

Specified by:

getDisplayValue in interface ITreeNode<T>

Returns:

the display value

getLevel

public int getLevel()

Returns the distance from the root to this node. Returns 0 if this node is the root.

Specified by:

getLevel in interface ITreeNode<T>

Returns:

the level from this node.

getNextSibling

public ITreeNode<T> getNextSibling()

Returns the next sibling of this node in the parent's children list. Returns null if this node is the root or is the parent's last child.

Specified by:

getNextSibling in interface ITreeNode<T>

Returns:

the next sibling of this node or null if this node is the root or is the parent's last child.

getParent

public ITreeNode<T> getParent()

Gets the parent.

Specified by:

getParent in interface ITreeNode<T>

Returns:

the parent

getPreviousSibling

public ITreeNode<T> getPreviousSibling()

Returns the previous sibling of this node in the parent's children list. Returns null if this node is the root or is the parent's first child.

Specified by:

getPreviousSibling in interface ITreeNode<T>

Returns:

the next sibling of this node or null if this node is the root or is the parent's last child.

getValue

public T getValue()

Gets the value.

Specified by:

getValue in interface ITreeNode<T>

Returns:

the value

hasChildren

public boolean hasChildren()

Checks for children.

Specified by:

hasChildren in interface ITreeNode<T>

Returns:

true, if successful

hashCode

public int hashCode()

Overrides:

hashCode in class Object

hasParent

public boolean hasParent()

Checks for parent.

Specified by:

hasParent in interface ITreeNode<T>

Returns:

true, if successful

isLeaf

public boolean isLeaf()

Checks if is leaf.

Specified by:

isLeaf in interface ITreeNode<T>

Returns:

true, if is leaf

isNode

public boolean isNode()

Checks if is node.

Specified by:

isNode in interface ITreeNode<T>

Returns:

true, if is node

isRoot

public boolean isRoot()

Checks if this treenode is root.

Specified by:

isRoot in interface ITreeNode<T>

Returns:

true, if is root

removeChild

public void removeChild(ITreeNode<T> child)

Removes the child.

Specified by:

removeChild in interface ITreeNode<T>

Parameters:

child - the child

removeChildAt

public void removeChildAt(int index)
                   throws IndexOutOfBoundsException

Removes the child.

Specified by:

removeChildAt in interface ITreeNode<T>

Parameters:

index - the index

Throws:

IndexOutOfBoundsException - the index out of bounds exception

setChildren

public void setChildren(List<ITreeNode<T>> children)

Sets the children.

Specified by:

setChildren in interface ITreeNode<T>

Parameters:

children - the new children

setDisplayValue

public void setDisplayValue(String displayValue)

Sets the optional display value.

Specified by:

setDisplayValue in interface ITreeNode<T>

Parameters:

displayValue - the new optional display value

setParent

public void setParent(ITreeNode<T> parent)

Sets the parent.

Specified by:

setParent in interface ITreeNode<T>

Parameters:

parent - the new parent

setValue

public void setValue(T value)

Sets the value.

Specified by:

setValue in interface ITreeNode<T>

Parameters:

value - the new value

toList

public List<ITreeNode<T>> toList()

To list.

Specified by:

toList in interface ITreeNode<T>

Returns:

the list

traverse

public void traverse(ITreeNode<T> node,
                     List<ITreeNode<T>> list)

Traverse.

Specified by:

traverse in interface ITreeNode<T>

Parameters:

node - the node

list - the list