org.auxis.commons.tree

Interface TreeBuilder

All Known Implementing Classes:

InMemoryTreeBuilderImpl, StaticTreeBuilder, StreamTreeBuilder

public interface TreeBuilder

The way for creating Trees.

Author:

Toni Menzel

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.

Method Detail

add

TreeBuilder add(byte[] bytes)

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

Parameters:

bytes - data to be hashed.

Returns:

this

selector

TreeBuilder selector(Selector selector)

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

Parameters:

selector - to be used from here on.

Returns:

this

branch

TreeBuilder branch(Selector selector)

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

Parameters:

selector - to be used on the newly created branch.

Returns:

A new sub tree.

branch

TreeBuilder branch(Tree subtree)

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

Parameters:

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

Returns:

An instance of StaticTreeBuilder

tag

TreeBuilder tag(Tag tag)

Tag this tree. Will overwrite previous tags.

Parameters:

tag -

Returns:

this

seal

Tree seal()

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

Returns:

A new instance representing the tree you've built.