Package com.puresoltechnologies.graphs.trees

Class TreeNodeImpl<N extends TreeNodeImpl<N>>

java.lang.Object

com.puresoltechnologies.graphs.trees.TreeNodeImpl<N>

Type Parameters:

N - is the type of the nodes. T needs to implement AbstractTreeImpl.

All Implemented Interfaces:

Vertex<N,TreeLink<N>>, TreeNode<N>, Iterable<N>

public class TreeNodeImpl<N extends TreeNodeImpl<N>>
extends Object
implements TreeNode<N>, Iterable<N>

This is an abstract, immutable implementation of a TreeNode.

Author:

Rick-Rainer Ludwig

Constructor Summary

Constructors

Constructor	Description
TreeNodeImpl(N parent, String name)	This is the initial value constructor.

Method Summary

Modifier and Type	Method	Description
protected void	addChild(N child)	This method is used to add children to a parent node in the constructor.
List<N>	getChildren()	This method returns the children which are contained in the node.
Set<TreeLink<N>>	getEdges()	This method returns the edges which are bound to the vertex.
String	getName()	This method returns the node identifier.
N	getParent()	This method returns the parent node.
boolean	hasChildren()	This method returns whether or not the current node contains children.
Iterator<N>	iterator()

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from class java.lang.Object

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

Constructor Detail

TreeNodeImpl

public TreeNodeImpl(N parent,
                    String name)

This is the initial value constructor.

Parameters:

parent - is the parent where this node is to be added to.

name - is the identifier of this node.

Method Detail

addChild

protected void addChild(N child)

This method is used to add children to a parent node in the constructor. This method should never be called from outside the constructor.

Parameters:

child - is the child to be added to the children list.

getParent

public N getParent()

Description copied from interface: TreeNode

This method returns the parent node.

Specified by:

getParent in interface TreeNode<N extends TreeNodeImpl<N>>

Returns:

A TreeNode of T is returned. null is returned if no parent is present and the current node is the root node.

hasChildren

public boolean hasChildren()

Description copied from interface: TreeNode

This method returns whether or not the current node contains children.

Specified by:

hasChildren in interface TreeNode<N extends TreeNodeImpl<N>>

Returns:

true is returned in case the node contains children. false is returned otherwise.

getChildren

public List<N> getChildren()

Description copied from interface: TreeNode

This method returns the children which are contained in the node.

Specified by:

getChildren in interface TreeNode<N extends TreeNodeImpl<N>>

Returns:

A List of T is returned. If not child is found this list is empty. The return value must not be null.

getEdges

public Set<TreeLink<N>> getEdges()

Description copied from interface: Vertex

This method returns the edges which are bound to the vertex. All edges should be returned here no matter whether they are outgoing or incoming.

Specified by:

getEdges in interface Vertex<N extends TreeNode<N>,TreeLink<N extends TreeNode<N>>>

Returns:

A Set is returned containing the edges which are bound to this vertex.

getName

public String getName()

Description copied from interface: TreeNode

This method returns the node identifier. Each node in a tree should have an identifying name. This is the most basic information. Implementation of this interface TreeNode may have other values, too.

Specified by:

getName in interface TreeNode<N extends TreeNodeImpl<N>>

Returns:

A String is returned containing the name.

iterator

public Iterator<N> iterator()

Specified by:

iterator in interface Iterable<N extends TreeNodeImpl<N>>