com.bonzaiengine.util

Class Tree<T>

java.lang.Object

com.bonzaiengine.util.Tree<T>

All Implemented Interfaces:

ITree<Tree<T>>

public class Tree<T>
extends java.lang.Object
implements ITree<Tree<T>>

See Also:

Trees

Constructor Summary

Constructors

Constructor and Description
Tree(T value)

Method Summary

Modifier and Type	Method and Description
void	addChild(Tree<T> childTree)
void	addChild(Tree<T> childTree, int insertIndex)
Tree<T>	connect(T childValue)
boolean	contains(Tree<T> node)
<A extends T,B extends A> Tree<A>	findParent(Tree<B> node)
T	get()
Tree<T>	getChild(int index)
Array<Tree<T>>	getChilds()
int	getNumChilds()
Array<Tree<T>>	getPathTo(Tree<? super T> root)
T	getValue()
boolean	isEmpty()
<R> Tree<R>	map(IConverter<R,T> mapper) Convert a Tree to a Tree using the IMapper to map R to T
boolean	reconnect(T parent, T child) Reconnect two existing Tree nodes from their respective values.
Tree<T>	remove(int index)
void	removeChilds() Remove all nodes from this Tree
<PT extends T> Tree<PT>	removeNode(Tree<PT> node)
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Tree

public Tree(T value)

Method Detail

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

get

public final T get()

Returns:

the value of this Tree node

getValue

public final T getValue()

Returns:

get()

getNumChilds

public final int getNumChilds()

Specified by:

getNumChilds in interface ITree<Tree<T>>

Returns:

the number of childs in this Tree

isEmpty

public final boolean isEmpty()

Returns:

true if this Tree is a leaf node (does not contains any child)

getChild

public final Tree<T> getChild(int index)

Specified by:

getChild in interface ITree<Tree<T>>

Parameters:

index - in the range [0; getNumChilds()[

Returns:

the child node at the specified index

getChilds

public final Array<Tree<T>> getChilds()

Returns:

the list of child nodes

removeChilds

public final void removeChilds()

Remove all nodes from this Tree

connect

public final Tree<T> connect(T childValue)

Parameters:

childValue - value to add

Returns:

the new or existing Tree containing the specified value

addChild

public final void addChild(Tree<T> childTree)

Specified by:

addChild in interface ITree<Tree<T>>

Parameters:

childTree - child Tree to connect to this Tree

addChild

public final void addChild(Tree<T> childTree,
                           int insertIndex)

Parameters:

childTree - child Tree to connect to this Tree

insertIndex - index of insertion

reconnect

public final boolean reconnect(T parent,
                               T child)

Reconnect two existing Tree nodes from their respective values.

Parameters:

parent - parent value

child - child value

Returns:

true if successfully connected

remove

public final Tree<T> remove(int index)

Parameters:

index - of the child to remove

Returns:

the child removed

removeNode

public final <PT extends T> Tree<PT> removeNode(Tree<PT> node)

Parameters:

node - a Tree node to remove

Returns:

the node's parent if removed, or null if not removed

map

public final <R> Tree<R> map(IConverter<R,T> mapper)

Convert a Tree to a Tree using the IMapper to map R to T

Parameters:

mapper - a IConverter to map R to a T object

Returns:

Tree

contains

public final boolean contains(Tree<T> node)

Parameters:

node - a Tree node

Returns:

true if this Tree contains the specified node.
false if this Tree does not contains (or is equals to) the specified node or

findParent

public final <A extends T,B extends A> Tree<A> findParent(Tree<B> node)

Parameters:

node - a Tree node

Returns:

the parent node of the specified Tree, or null if not found

getPathTo

public final Array<Tree<T>> getPathTo(Tree<? super T> root)

Parameters:

root - root Tree

Returns:

list containing the path from this Tree to the specified root Tree, or null if not found
the head (first) and tail (last) elements of the list are respectively root and this