com.github.jtendermint.merkletree

Class MerkleTree<K extends IByteable>

java.lang.Object

com.github.jtendermint.merkletree.MerkleTree<K>

All Implemented Interfaces:

IMerkleTree<K>

public class MerkleTree<K extends IByteable>
extends Object
implements IMerkleTree<K>

Constructor Summary

Constructors

Constructor and Description
MerkleTree()

Method Summary

Modifier and Type	Method and Description
boolean	add(K entry) Add or update the entry to/in the tree.
boolean	contains(K key) Check if an entry is already present
protected MerkleNode<K>	createNode(K entry)
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 key) Remove an entry from the tree
int	size()
String	toPrettyString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MerkleTree

public MerkleTree()

Method Detail

size

public int size()

Specified by:

size in interface IMerkleTree<K extends IByteable>

Returns:

the tree size (elements in tree)

getHeight

public int getHeight()

Specified by:

getHeight in interface IMerkleTree<K extends IByteable>

Returns:

the tree-height

contains

public boolean contains(K key)

Description copied from interface: IMerkleTree

Check if an entry is already present

Specified by:

contains in interface IMerkleTree<K extends IByteable>

Parameters:

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

Returns:

true if the entry is in this tree

get

public K get(K entry)

Description copied from interface: IMerkleTree

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

Specified by:

get in interface IMerkleTree<K extends IByteable>

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

public KeyIndex<K> get(int index)

Specified by:

get in interface IMerkleTree<K extends IByteable>

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

public boolean add(K entry)

Description copied from interface: IMerkleTree

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

Specified by:

add in interface IMerkleTree<K extends IByteable>

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

public RemoveResult<K> remove(K key)

Description copied from interface: IMerkleTree

Remove an entry from the tree

Specified by:

remove in interface IMerkleTree<K extends IByteable>

Parameters:

key - the entry to remove

Returns:

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

getHashWithCount

public HashWithCount getHashWithCount()

Specified by:

getHashWithCount in interface IMerkleTree<K extends IByteable>

Returns:

the Root-Hash and the amount of hashes

getRootHash

public byte[] getRootHash()

Specified by:

getRootHash in interface IMerkleTree<K extends IByteable>

Returns:

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

getRoot

public MerkleNode<K> getRoot()

Specified by:

getRoot in interface IMerkleTree<K extends IByteable>

Returns:

the Root-Node. May be null.

toPrettyString

public String toPrettyString()

Specified by:

toPrettyString in interface IMerkleTree<K extends IByteable>

Returns:

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

iterateNodes

public boolean iterateNodes(IterateFunction<K> function)

Description copied from interface: IMerkleTree

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

Specified by:

iterateNodes in interface IMerkleTree<K extends IByteable>

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

createNode

protected MerkleNode<K> createNode(K entry)