com.nwawsoft.util.datastructures

Class BinaryTree

java.lang.Object

com.nwawsoft.util.datastructures.Tree

com.nwawsoft.util.datastructures.BinaryTree

public class BinaryTree
extends Tree

Tree data structure which can contain up to 2 additional Trees. Every BinaryTree can be a root itself, can contain one or no content object and none, one or two additional Tree objects. These can be any Tree objects and do not have to be BinaryTree objects.

Constructor Summary

Constructors

Constructor and Description
BinaryTree() Creates an empty BinaryTree.
BinaryTree(List treeList) Deprecated. Why would anyone want to create a BinaryTree from a List?! Just use any other constructor.
BinaryTree(Tree leftTree, Tree rightTree) Creates a BinaryTree and sets the left and right tree.
BinaryTree(Tree leftTree, Tree rightTree, java.lang.Object content) Creates a BinaryTree and sets the left and right tree.

Method Summary

Modifier and Type	Method and Description
void	addTree(Tree t) Deprecated. use setLeftTree/setRightTree/getLeftTree/getRightTree instead.
java.lang.Object	getContent() Returns the stored object.
Tree	getLeftTree()
Tree	getRightTree()
int	getSubTreeCount() Returns the amount of non-null tree objects in the BinaryTree.
Tree	getTree(int index) Returns the Tree with the specified index, starting from 0.
void	removeTree(int index) Deprecated. use setLeftTree/setRightTree/getLeftTree/getRightTree instead.
void	setContent(java.lang.Object content) Sets an object into the Tree's content storage.
void	setLeftTree(Tree leftTree)
void	setRightTree(Tree rightTree)

Methods inherited from class com.nwawsoft.util.datastructures.Tree

getTrees

Methods inherited from class java.lang.Object

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

Constructor Detail

BinaryTree

public BinaryTree()

Creates an empty BinaryTree.

BinaryTree

public BinaryTree(Tree leftTree,
                  Tree rightTree)

Creates a BinaryTree and sets the left and right tree. Contents may be null.

Parameters:

leftTree - the Tree object to go in the leftTree storage.

rightTree - the Tree object to go in the rightTree storage.

BinaryTree

public BinaryTree(Tree leftTree,
                  Tree rightTree,
                  java.lang.Object content)

Creates a BinaryTree and sets the left and right tree. Contents may be null.

Parameters:

leftTree - the Tree object to go in the leftTree storage.

rightTree - the Tree object to go in the rightTree storage.

content - any object of any type.

BinaryTree

@Deprecated
public BinaryTree(List treeList)

Deprecated. Why would anyone want to create a BinaryTree from a List?! Just use any other constructor.

Creates a new BinaryTree from the first two objects of treeList and sets them as leftTree and rightTree, respectively. Exists only because the normal Tree can be created with a child list as well.

Parameters:

treeList - a list of Tree objects.

Method Detail

getLeftTree

public Tree getLeftTree()

setLeftTree

public void setLeftTree(Tree leftTree)

getRightTree

public Tree getRightTree()

setRightTree

public void setRightTree(Tree rightTree)

getTree

public Tree getTree(int index)

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

Overrides:

getTree in class Tree

Parameters:

index - 0 for the first tree, 1 for the second tree.

Returns:

the Tree object with the specified index.

getContent

public java.lang.Object getContent()

Returns the stored object.

Overrides:

getContent in class Tree

Returns:

null if content is empty, otherwise the content object.

setContent

public void setContent(java.lang.Object content)

Sets an object into the Tree's content storage.

Overrides:

setContent in class Tree

Parameters:

content - any object of any type. May be null.

addTree

@Deprecated
public void addTree(Tree t)

Deprecated. use setLeftTree/setRightTree/getLeftTree/getRightTree instead.

Sets the passed Tree object to the next available slot (starting with the left). If there is none, it is ignored.

Overrides:

addTree in class Tree

Parameters:

t - a Tree object.

removeTree

@Deprecated
public void removeTree(int index)

Deprecated. use setLeftTree/setRightTree/getLeftTree/getRightTree instead.

Does nothing.

Overrides:

removeTree in class Tree

Parameters:

index - the index of nothing, because this shouldn't be used.

getSubTreeCount

public int getSubTreeCount()

Returns the amount of non-null tree objects in the BinaryTree. This can be either 0, 1 or 2.

Overrides:

getSubTreeCount in class Tree

Returns:

the amount of tree objects in this BinaryTree.