com.github.jtendermint.merkletree

Interface IMerkleTree<K extends IByteable>

All Known Implementing Classes:

MerkleTree

public interface IMerkleTree<K extends IByteable>

Method Summary

Modifier and Type	Method and Description
boolean	add(K entry) Add or update the entry to/in the tree.
boolean	contains(K entry) Check if an entry is already present
KeyIndex<K>	get(int index)
K	get(K entry) Return an entry from the tree, uses Object.equals(Object) for equality-checks
HashWithCount	getHashWithCount()
int	getHeight()
MerkleNode<K>	getRoot()
byte[]	getRootHash()
boolean	iterateNodes(IterateFunction<K> function) Iterate over every node.
RemoveResult<K>	remove(K entry) Remove an entry from the tree
int	size()
String	toPrettyString()

Method Detail

size

int size()

Returns:

the tree size (elements in tree)

getHeight

int getHeight()

Returns:

the tree-height

contains

boolean contains(K entry)

Check if an entry is already present

Parameters:

entry - the Entry to search for in this tree. Should not be null

Returns:

true if the entry is in this tree

get

K get(K entry)

Return an entry from the tree, uses Object.equals(Object) for equality-checks

Parameters:

entry - a non-null entry to lookup in the tree

Returns:

the entry from the tree or null if this entry is not in the tree

get

KeyIndex<K> get(int index)

Parameters:

index - the index of the node where the entry should be retrieved

Returns:

a KeyIndex representing the element at the requested index. Never null.

add

boolean add(K entry)

Add or update the entry to/in the tree. If this entry already existed, the existing node will be updated

Parameters:

entry - the non-null entry to add

Returns:

true if the entry has been updated in the tree, false if this entry has been newly added

remove

RemoveResult<K> remove(K entry)

Remove an entry from the tree

Parameters:

entry - the entry to remove

Returns:

a RemoveResult representing the result of the remove operation. Never null.

getHashWithCount

HashWithCount getHashWithCount()

Returns:

the Root-Hash and the amount of hashes

getRootHash

byte[] getRootHash()

Returns:

the root-hash. Will be null if the root-node is or if the rootHash has never been calculated.

getRoot

MerkleNode<K> getRoot()

Returns:

the Root-Node. May be null.

toPrettyString

String toPrettyString()

Returns:

a prettify string representation of this tree for debugging: ((1 2) (3 4))

iterateNodes

boolean iterateNodes(IterateFunction<K> function)

Iterate over every node. check Leafnodes with node.isLeafNode()

Parameters:

function - a IterateFunction that should be executed for node

Returns:

false when nothing has been iterated. true when iteration ended after at least one leaf