org.auxis.commons.tree.util

Class StreamTreeBuilder

java.lang.Object

org.auxis.commons.tree.util.StreamTreeBuilder

All Implemented Interfaces:

TreeBuilder

public class StreamTreeBuilder
extends Object
implements TreeBuilder

Constructor Summary

Constructors

Constructor and Description
StreamTreeBuilder(TreeBuilder delegate)

Method Summary

Modifier and Type	Method and Description
StreamTreeBuilder	add(byte[] bytes) Add data to the current tree.
StreamTreeBuilder	add(File f)
StreamTreeBuilder	add(InputStream is)
StreamTreeBuilder	branch(Selector selector) Create a new branch (Tree) with given selector.
StreamTreeBuilder	branch(Tree subtree) Create a new branch (Tree) with given selector.
long	getDataRead()
void	reset()
Tree	seal() Close this TreeBuilder and seal the entire subtree.
StreamTreeBuilder	selector(Selector selector) Change selector.
StreamTreeBuilder	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

StreamTreeBuilder

public StreamTreeBuilder(TreeBuilder delegate)

Method Detail

add

public StreamTreeBuilder add(InputStream is)
                      throws IOException

Throws:

IOException

add

public StreamTreeBuilder add(File f)

getDataRead

public long getDataRead()

reset

public void reset()

add

public StreamTreeBuilder 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 StreamTreeBuilder 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 StreamTreeBuilder 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 StreamTreeBuilder 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 StreamTreeBuilder 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.