com.guardtime.ksi.tree

Class ImprintNode

java.lang.Object

com.guardtime.ksi.tree.ImprintNode

All Implemented Interfaces:

TreeNode

public class ImprintNode
extends Object
implements TreeNode

Represents a hash tree node. Every non-leaf node is labelled with the hash of the labels or values (in case of leaves) of its child nodes.

Constructor Summary

Constructors

Constructor and Description
ImprintNode(DataHash value) Creates a new leaf node with given hash and level 0.
ImprintNode(DataHash value, long level) Creates a leaf node with given hash and level.
ImprintNode(ImprintNode node) Creates a copy of a node.
ImprintNode(ImprintNode leftChild, ImprintNode rightChild, DataHash value, long level) Creates a non-leaf node.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
TreeNode	getLeftChildNode()
long	getLevel()
TreeNode	getParent()
TreeNode	getRightChildNode()
byte[]	getValue()
int	hashCode()
boolean	hasMetadata()
boolean	isLeaf()
boolean	isLeft()
boolean	isRoot()

Methods inherited from class java.lang.Object

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

Constructor Detail

ImprintNode

public ImprintNode(ImprintNode node)

Creates a copy of a node.

Parameters:

node - node to be copied.

ImprintNode

public ImprintNode(DataHash value)

Creates a new leaf node with given hash and level 0.

Parameters:

value - hash of the new node.

ImprintNode

public ImprintNode(DataHash value,
                   long level)

Creates a leaf node with given hash and level.

Parameters:

value - hash of the new node.

level - level of the new node.

ImprintNode

public ImprintNode(ImprintNode leftChild,
                   ImprintNode rightChild,
                   DataHash value,
                   long level)

Creates a non-leaf node.

Parameters:

leftChild - left child node of the new node.

rightChild - right child node of the new node.

value - hash of the new node.

level - level of the new node.

Method Detail

getValue

public byte[] getValue()

Specified by:

getValue in interface TreeNode

Returns:

The value of the node, must always be present.

getParent

public TreeNode getParent()

Specified by:

getParent in interface TreeNode

Returns:

The parent node. In case of root (head) node, null is returned.

getLeftChildNode

public TreeNode getLeftChildNode()

Specified by:

getLeftChildNode in interface TreeNode

Returns:

Left child node. In case of leaf node, null is returned.

getRightChildNode

public TreeNode getRightChildNode()

Specified by:

getRightChildNode in interface TreeNode

Returns:

Right child node. In case of leaf node, null is returned.

isLeft

public boolean isLeft()

Specified by:

isLeft in interface TreeNode

Returns:

True, if this node is left child node.

getLevel

public long getLevel()

Specified by:

getLevel in interface TreeNode

Returns:

The height of the node.

isRoot

public boolean isRoot()

Specified by:

isRoot in interface TreeNode

Returns:

True, if current node is the root (head) node.

isLeaf

public boolean isLeaf()

Specified by:

isLeaf in interface TreeNode

Returns:

True, if current node is the leaf node.

hasMetadata

public boolean hasMetadata()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object