com.guardtime.ksi.tree

Interface TreeBuilder<N extends TreeNode>

All Known Implementing Classes:

BlindingMaskLinkingHashTreeBuilder, CanonicalHashTreeBuilder, HashTreeBuilder

public interface TreeBuilder<N extends TreeNode>

Provides the means to build a binary tree where every node in the tree has at most two children.

To add new leaves to the tree, methods add(TreeNode) or add(TreeNode...) can be used.

Note that this interface does not describe how leaves are processed and how binary tree is built. Several different implementations can exist to support different types of trees. For example some implementation can sort leaves and by doing so break the order of the leaves.

Method Summary

Modifier and Type	Method and Description
void	add(N... nodes) Adds a new list of leaves to the binary tree.
void	add(N node) Adds a new leaf to the binary tree.
void	add(N node, IdentityMetadata metadata) Adds a new leaf with its metadata to the binary tree.
N	build() Builds the binary tree and returns the root hash of the tree.
long	calculateHeight(N node) Calculates the binary tree height if new leaf would be added.
long	calculateHeight(N node, IdentityMetadata metadata) Calculates the binary tree height if new leaf with metadata would be added.

Method Detail

add

void add(N node)
  throws KSIException

Adds a new leaf to the binary tree.

Parameters:

node - a leaf to add to the tree, must not be null.

Throws:

KSIException

add

void add(N node,
         IdentityMetadata metadata)
  throws HashException,
         KSIException

Adds a new leaf with its metadata to the binary tree. Some implementations of the add(TreeNode, IdentityMetadata) may not support IdentityMetadata and may throw an UnsupportedOperationException.

Parameters:

node - leaf node to be added, must not be null.

metadata - node's metadata, must not be null

Throws:

HashException

KSIException

UnsupportedOperationException - if operation is not supported

calculateHeight

long calculateHeight(N node)
              throws KSIException

Calculates the binary tree height if new leaf would be added.

Parameters:

node - a leaf to be added to the tree, must not be null.

Returns:

Binary tree height.

Throws:

KSIException

calculateHeight

long calculateHeight(N node,
                     IdentityMetadata metadata)
              throws HashException,
                     KSIException

Calculates the binary tree height if new leaf with metadata would be added. Some implementations of the calculateHeight(TreeNode, IdentityMetadata) may not support IdentityMetadata and may throw an UnsupportedOperationException.

Parameters:

node - a leaf to be added to the tree, must not be null.

metadata - node's metadata, must not be null

Returns:

Binary tree height.

Throws:

HashException

KSIException

UnsupportedOperationException - if operation is not supported

add

void add(N... nodes)
  throws KSIException

Adds a new list of leaves to the binary tree.

Parameters:

nodes - a list of leaves to be added to the tree, must not be null.

Throws:

KSIException

build

N build()
 throws KSIException

Builds the binary tree and returns the root hash of the tree. TreeNode.getLeftChildNode() and/or TreeNode.getRightChildNode() methods can be used for tree traversal.

Returns:

Root hash of the tree.

Throws:

KSIException