com.nwawsoft.util.datastructures

Class Tree

java.lang.Object

com.nwawsoft.util.datastructures.Tree

Direct Known Subclasses:

BinaryTree

public class Tree
extends java.lang.Object

Tree data structure which can contain infinitely many other Trees. Every Tree can be a root itself and can contain one or no 'content' object.

Constructor Summary

Constructors

Constructor and Description
Tree() Creates an empty Tree object.
Tree(List treeList) Creates a Tree object that stores a passed List of Tree objects.
Tree(List treeList, boolean allowNull) Creates a Tree object that stores a passed List of Tree objects.

Method Summary

Modifier and Type	Method and Description
void	addTree(Tree t) Adds the specified Tree object to treeList and increases subTreeCount by 1 to keep it synchronized.
java.lang.Object	getContent() Returns the content of the Tree object.
int	getSubTreeCount() Returns the amount of elements in treeList.
Tree	getTree(int index) Returns the tree with the specified index, starting from 0.
List	getTrees() Deprecated. this is only for easier testing purposes but modifying the internal list via this call may invalidate the integrity of the synchronization between treeList and subTreeCount.
void	removeTree(int index) Removes the specified Tree object from treeList and decreases subTreeCount by 1 to keep it synchronized.
void	setContent(java.lang.Object content) Sets the content of the Tree object.

Methods inherited from class java.lang.Object

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

Constructor Detail

Tree

public Tree()

Creates an empty Tree object.

Tree

public Tree(List treeList)

Creates a Tree object that stores a passed List of Tree objects. If the List contained non-Tree objects or null objects they are filtered out.

Parameters:

treeList - a List of Tree objects.

Tree

public Tree(List treeList,
            boolean allowNull)

Creates a Tree object that stores a passed List of Tree objects. If the List contained non-Tree object they are filtered out.

Parameters:

treeList - a List of Tree objects.

allowNull - whether null values shall be kept and take a slot in the list.

Method Detail

addTree

public void addTree(Tree t)

Adds the specified Tree object to treeList and increases subTreeCount by 1 to keep it synchronized.

Parameters:

t - a Tree object.

removeTree

public void removeTree(int index)

Removes the specified Tree object from treeList and decreases subTreeCount by 1 to keep it synchronized.

Parameters:

index - the index of the tree object to delete, starting from 0.

getContent

public java.lang.Object getContent()

Returns the content of the Tree object.

Returns:

the content of the Tree object.

setContent

public void setContent(java.lang.Object content)

Sets the content of the Tree object.

Parameters:

content - the content of the Tree object.

getTree

public Tree getTree(int index)

Returns the tree with the specified index, starting from 0.

Parameters:

index - the index of the desired Tree object.

Returns:

the Tree object with the specified index.

getTrees

@Deprecated
public List getTrees()

Deprecated. this is only for easier testing purposes but modifying the internal list via this call may invalidate the integrity of the synchronization between treeList and subTreeCount.

Returns the treeList of the Tree object. This should never be manually modified. Instead, use the other methods of this class to ensure synchronization between treeList and subTreeCount.

Returns:

the List of Tree objects this Tree object contains.

getSubTreeCount

public int getSubTreeCount()

Returns the amount of elements in treeList.

Returns:

the amount of Tree objects in treeList.