org.lsst.ccs.utilities.structs

Class TreeBranch<T extends Serializable>

java.lang.Object

org.lsst.ccs.utilities.structs.TreeBranch<T>

Type Parameters:

T -

All Implemented Interfaces:

Serializable, Iterable<T>, TreeNode

public class TreeBranch<T extends Serializable>
extends Object
implements Serializable, TreeNode, Iterable<T>

Immutable simple tree that can be used by swing Trees.

Author:

bamade

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	TreeBranch.PreOrderIterator<X extends Serializable> inner class that delegates to PreOrderNodeIterator to fetch content in pre-order.
protected static class	TreeBranch.PreOrderNodeIterator<X extends Serializable> Inner class to fetch nodes in pre-order.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TreeBranch() Avoid using this constructor: for beans purposes use the constructor annotated with ConstructorProperties
	TreeBranch(T content) to be used initially to build the root (avoid otherwise)
	TreeBranch(TreeBranch<T> parent, T content) prefer the use of this constructor when building a tree (instead of using sequence one-arg constructor + addChild)

Method Summary

Modifier and Type	Method and Description
void	addChild(TreeBranch<T> child) adds a child to the current node.
Enumeration	children()
String	deepString() returns a String that represents the tree
protected String	deepString(int level)
boolean	getAllowsChildren() since the tree is immutable this method is not intended to be called during building operations.
TreeNode	getChildAt(int childIndex)
int	getChildCount()
Iterator<TreeBranch<T>>	getChildIterator()
List<TreeBranch<T>>	getChildren()
T	getContent()
int	getCurrentIndex()
int	getIndex(TreeNode node)
TreeNode	getParent()
List<TreeBranch<T>>	getPath()
TreeBranch<T>	getRealParent() same as getParent but with proper return type
boolean	isLeaf()
boolean	isRootNode()
Iterator<T>	iterator()
Iterator<TreeBranch<T>>	nodeIterator()
void	setContent(T content)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

TreeBranch

public TreeBranch(T content)

to be used initially to build the root (avoid otherwise)

Parameters:

content -

TreeBranch

protected TreeBranch()

Avoid using this constructor: for beans purposes use the constructor annotated with ConstructorProperties

TreeBranch

@ConstructorProperties(value={"realParent","content"})
public TreeBranch(TreeBranch<T> parent,
                                                                         T content)

prefer the use of this constructor when building a tree (instead of using sequence one-arg constructor + addChild)

Parameters:

parent - may be null if node is intended as a root Node.

content -

Method Detail

addChild

public void addChild(TreeBranch<T> child)

adds a child to the current node. Prefer the use of the 2-args constructor if possible;

Parameters:

child -

getContent

public T getContent()

Returns:

the data stored in this node

setContent

public void setContent(T content)

Parameters:

content - the content to be set

getCurrentIndex

public int getCurrentIndex()

Returns:

the current index of this node in the parent's child list. For the rootNode the index is -1 ;

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T extends Serializable>

Returns:

an iterator of contents where tree is explored in preOrder.

nodeIterator

public Iterator<TreeBranch<T>> nodeIterator()

Returns:

an iterator of nodes where tree is explored in preOrder.

getChildren

public List<TreeBranch<T>> getChildren()

Returns:

the list of immediate children of this node or an empty list if none

getChildIterator

public Iterator<TreeBranch<T>> getChildIterator()

Returns:

an iterator over immediate children or an empty Iterator if none

getPath

public List<TreeBranch<T>> getPath()

Returns:

the list of parent nodes starting from the rootNode

getChildAt

public TreeNode getChildAt(int childIndex)

Specified by:

getChildAt in interface TreeNode

Parameters:

childIndex -

Returns:

the child at the requested index or null if out of range.

getChildCount

public int getChildCount()

Specified by:

getChildCount in interface TreeNode

Returns:

the number of children of this node

getParent

public TreeNode getParent()

Specified by:

getParent in interface TreeNode

Returns:

the parent of this node with type TreeNode (TreeNode interface contract)

getRealParent

public TreeBranch<T> getRealParent()

same as getParent but with proper return type

Returns:

a TreeBranch node or null when at the top of the tree.

getIndex

public int getIndex(TreeNode node)

Specified by:

getIndex in interface TreeNode

Parameters:

node - should be a child node of the current node

Returns:

the index in the child list or -1 if the argument is not found in this list

getAllowsChildren

public boolean getAllowsChildren()

since the tree is immutable this method is not intended to be called during building operations. It is here for the TreeNode contract.

Specified by:

getAllowsChildren in interface TreeNode

Returns:

isLeaf

public boolean isLeaf()

Specified by:

isLeaf in interface TreeNode

Returns:

true if this node has no children

isRootNode

public boolean isRootNode()

Returns:

true of this node is the top of the tree.

children

public Enumeration children()

Specified by:

children in interface TreeNode

Returns:

an enumeration over children of this node (TreeNode interface contract)

toString

public String toString()

Overrides:

toString in class Object

Returns:

a String representing the value attached to this node.

deepString

public String deepString()

returns a String that represents the tree

Returns:

deepString

protected String deepString(int level)