org.auxis.commons.tree

Class StaticTreeBuilder

java.lang.Object

org.auxis.commons.tree.StaticTreeBuilder

All Implemented Interfaces:

TreeBuilder

public class StaticTreeBuilder
extends Object
implements TreeBuilder

Augments a given tree as TreeBuilder. Used to incorporate existing Trees in Tree construction.

Author:

Toni Menzel

Constructor Summary

Constructors

Constructor and Description
StaticTreeBuilder(Tree encapsulatedTree)

Method Summary

Modifier and Type	Method and Description
TreeBuilder	add(byte[] bytes) Add data to the current tree.
TreeBuilder	branch(Selector selector) Create a new branch (Tree) with given selector.
TreeBuilder	branch(Tree subtree) Create a new branch (Tree) with given selector.
Tree	seal() Close this TreeBuilder and seal the entire subtree.
TreeBuilder	selector(Selector selector) Change selector.
TreeBuilder	tag(Tag tag) Tag this tree.

Methods inherited from class java.lang.Object

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

Constructor Detail

StaticTreeBuilder

public StaticTreeBuilder(Tree encapsulatedTree)

Method Detail

add

public TreeBuilder add(byte[] bytes)

Description copied from interface: TreeBuilder

Add data to the current tree. Only possible before TreeBuilder.seal() is called.

Specified by:

add in interface TreeBuilder

Parameters:

bytes - data to be hashed.

Returns:

this

selector

public TreeBuilder selector(Selector selector)

Description copied from interface: TreeBuilder

Change selector. Useful when selector is computed while adding data to the tree. Only possible before TreeBuilder.seal() is called.

Specified by:

selector in interface TreeBuilder

Parameters:

selector - to be used from here on.

Returns:

this

branch

public TreeBuilder branch(Selector selector)

Description copied from interface: TreeBuilder

Create a new branch (Tree) with given selector. Only possible before TreeBuilder .seal() is called.

Specified by:

branch in interface TreeBuilder

Parameters:

selector - to be used on the newly created branch.

Returns:

A new sub tree.

branch

public TreeBuilder branch(Tree subtree)

Description copied from interface: TreeBuilder

Create a new branch (Tree) with given selector. Only possible before TreeBuilder .seal() is called.

Specified by:

branch in interface TreeBuilder

Parameters:

subtree - tree to be added as branch. Note that this branch of cause will be unmodifiable.

Returns:

An instance of StaticTreeBuilder

tag

public TreeBuilder tag(Tag tag)

Description copied from interface: TreeBuilder

Tag this tree. Will overwrite previous tags.

Specified by:

tag in interface TreeBuilder

Returns:

this

seal

public Tree seal()

Description copied from interface: TreeBuilder

Close this TreeBuilder and seal the entire subtree. This actually gives you the desired inmodifiable datastructure.

Specified by:

seal in interface TreeBuilder

Returns:

A new instance representing the tree you've built.