de.alpharogroup.tree.ifaces

Interface ITreeNode<T>

Type Parameters:

T - the generic type

All Superinterfaces:

Serializable

All Known Implementing Classes:

TreeNode

public interface ITreeNode<T>
extends Serializable

The Interface ITreeNode.

Method Summary

Modifier and Type	Method and Description
default void	addChild(ITreeNode<T> child) Adds the child.
default void	addChildAt(int index, ITreeNode<T> child) Adds the child.
default List<ITreeNode<T>>	getAllSiblings() Returns all siblings of this node in the parent's children list.
default int	getChildCount() Gets the child count.
List<ITreeNode<T>>	getChildren() Gets the children.
default 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.
default int	getLevel() Returns the distance from the root to this node.
default ITreeNode<T>	getNextSibling() Returns the next sibling of this node in the parent's children list.
ITreeNode<T>	getParent() Gets the parent.
default ITreeNode<T>	getPreviousSibling() Returns the previous sibling of this node in the parent's children list.
default ITreeNode<T>	getRoot() Gets the root ITreeNode object
T	getValue() Gets the value.
default boolean	hasChildren() Checks for children.
default boolean	hasParent() Checks for parent
default boolean	isLeaf() Checks if is leaf.
default boolean	isNode() Checks if is node.
default boolean	isRoot() Checks if this ITreeNode is the root ITreeNode object
default void	removeChild(ITreeNode<T> child) Removes the child.
default 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.
default List<ITreeNode<T>>	toList() To list.
default void	traverse(ITreeNode<T> node, List<ITreeNode<T>> list) Traverse.

Method Detail

addChild

default void addChild(ITreeNode<T> child)

Adds the child.

Parameters:

child - the child

addChildAt

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

Adds the child.

Parameters:

index - the index

child - the child

Throws:

IndexOutOfBoundsException - the index out of bounds exception

getAllSiblings

default List<ITreeNode<T>> getAllSiblings()

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

Returns:

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

getChildCount

default int getChildCount()

Gets the child count.

Returns:

the child count

getChildren

List<ITreeNode<T>> getChildren()

Gets the children.

Returns:

the children

getDepth

default int getDepth()

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

Returns:

the depth of the tree beginning at this node.

getDisplayValue

String getDisplayValue()

Gets the optional display value.

Returns:

the display value

getLevel

default int getLevel()

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

Returns:

the level from this node.

getNextSibling

default 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.

Returns:

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

getParent

ITreeNode<T> getParent()

Gets the parent.

Returns:

the parent

getPreviousSibling

default 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.

Returns:

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

getRoot

default ITreeNode<T> getRoot()

Gets the root ITreeNode object

Returns:

the root ITreeNode object

getValue

T getValue()

Gets the value.

Returns:

the value

hasChildren

default boolean hasChildren()

Checks for children.

Returns:

true, if successful

hasParent

default boolean hasParent()

Checks for parent

Returns:

true, if successful

isLeaf

default boolean isLeaf()

Checks if is leaf.

Returns:

true, if is leaf

isNode

default boolean isNode()

Checks if is node.

Returns:

true, if is node

isRoot

default boolean isRoot()

Checks if this ITreeNode is the root ITreeNode object

Returns:

true, if this ITreeNode is the root ITreeNode object

removeChild

default void removeChild(ITreeNode<T> child)

Removes the child.

Parameters:

child - the child

removeChildAt

default void removeChildAt(int index)
                    throws IndexOutOfBoundsException

Removes the child.

Parameters:

index - the index

Throws:

IndexOutOfBoundsException - the index out of bounds exception

setChildren

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

Sets the children.

Parameters:

children - the new children

setDisplayValue

void setDisplayValue(String displayValue)

Sets the optional display value.

Parameters:

displayValue - the new optional display value

setParent

void setParent(ITreeNode<T> parent)

Sets the parent.

Parameters:

parent - the new parent

setValue

void setValue(T value)

Sets the value.

Parameters:

value - the new value

toList

default List<ITreeNode<T>> toList()

To list.

Returns:

the list

traverse

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

Traverse.

Parameters:

node - the node

list - the list