com.guardtime.ksi.hashing

Class DataHash

java.lang.Object

com.guardtime.ksi.hashing.DataHash

public class DataHash
extends Object

Representation of hash values as hash computation results. Includes name of the algorithm used and computed hash value.

Constructor Summary

Constructors

Constructor and Description
DataHash(byte[] hashImprint) Constructor which initializes the DataHash.
DataHash(HashAlgorithm algorithm, byte[] value) Constructor which initializes the DataHash.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object object) Checks if object is equal to current DataHash.
HashAlgorithm	getAlgorithm() Gets the HashAlgorithm used to compute this DataHash.
byte[]	getImprint() Gets data imprint.
byte[]	getValue() Gets the computed hash value for DataHash.
int	hashCode() Gets the hash code of current object.
static boolean	isDataHash(byte[] imprint) Checks if the input byte array can be converted to the DataHash object.
String	toString() Get DataHash as a string including the algorithm name and computed hash value.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataHash

public DataHash(HashAlgorithm algorithm,
                byte[] value)

Constructor which initializes the DataHash.

Parameters:

algorithm - HashAlgorithm used to compute this hash.

value - hash value computed for the input data.

Throws:

NullPointerException - when one of input parameters is null.

IllegalArgumentException - when hash size does not match algorithm size.

DataHash

public DataHash(byte[] hashImprint)

Constructor which initializes the DataHash.

Parameters:

hashImprint - Hash imprint.

Throws:

NullPointerException - when input parameter is null.

IllegalArgumentException - when hash imprint is not in correct format.

Method Detail

isDataHash

public static boolean isDataHash(byte[] imprint)

Checks if the input byte array can be converted to the DataHash object.

Parameters:

imprint - byte array to be checked.

Returns:

True, if the input byte array can be converted to the DataHash object.

Throws:

NullPointerException - when input is null

getAlgorithm

public final HashAlgorithm getAlgorithm()

Gets the HashAlgorithm used to compute this DataHash.

Returns:

HashAlgorithm used.

getImprint

public final byte[] getImprint()

Gets data imprint.

Imprint is created by concatenating hash algorithm ID with hash value.

Returns:

Imprint bytes.

getValue

public final byte[] getValue()

Gets the computed hash value for DataHash.

Returns:

Computed hash value.

hashCode

public final int hashCode()

Gets the hash code of current object.

Overrides:

hashCode in class Object

Returns:

Hash code of current object.

equals

public final boolean equals(Object object)

Checks if object is equal to current DataHash.

Overrides:

equals in class Object

Parameters:

object - object to be checked.

Returns:

True, if the object and the DataHash are equal.

toString

public final String toString()

Get DataHash as a string including the algorithm name and computed hash value.

Overrides:

toString in class Object

Returns:

String representing algorithm name and value.