io.nem.symbol.sdk.model.transaction

Enum LockHashAlgorithm

java.lang.Object

java.lang.Enum<LockHashAlgorithm>

io.nem.symbol.sdk.model.transaction.LockHashAlgorithm

All Implemented Interfaces:

Hasher, java.io.Serializable, java.lang.Comparable<LockHashAlgorithm>

public enum LockHashAlgorithm
extends java.lang.Enum<LockHashAlgorithm>
implements Hasher

Enum containing hash type.

Since:

1.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
HASH_160 hashed twice: first with SHA-256 and then with RIPEMD-160 (BTC Compat)
HASH_256 Hashed twice with SHA-256 (BTC Compat)
SHA3_256 hashed using SHA3-256 (Catapult Native)

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_SECRET_BYTE_ARRAY_SIZE The default size used for secret hashes.
static int	DEFAULT_SECRET_HEX_SIZE The default size used for secret hashes.
static java.lang.String	VALIDATOR_REGEX The regex used to validate a hashed value.

Method Summary

Modifier and Type	Method and Description
int	getValue()
byte[]	hash(byte[]... values) Use this method to just hash values when the LockHashAlgorithmType is known.
static LockHashAlgorithm	rawValueOf(int value)
static boolean	validator(LockHashAlgorithm hashType, java.lang.String input) Validate hash algorithm and hash have desired format
static LockHashAlgorithm	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static LockHashAlgorithm[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SHA3_256

public static final LockHashAlgorithm SHA3_256

hashed using SHA3-256 (Catapult Native)

HASH_160

public static final LockHashAlgorithm HASH_160

hashed twice: first with SHA-256 and then with RIPEMD-160 (BTC Compat)

HASH_256

public static final LockHashAlgorithm HASH_256

Hashed twice with SHA-256 (BTC Compat)

Field Detail

VALIDATOR_REGEX

public static final java.lang.String VALIDATOR_REGEX

The regex used to validate a hashed value.

See Also:

Constant Field Values

DEFAULT_SECRET_BYTE_ARRAY_SIZE

public static final int DEFAULT_SECRET_BYTE_ARRAY_SIZE

The default size used for secret hashes.

See Also:

Constant Field Values

DEFAULT_SECRET_HEX_SIZE

public static final int DEFAULT_SECRET_HEX_SIZE

The default size used for secret hashes.

See Also:

Constant Field Values

Method Detail

values

public static LockHashAlgorithm[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (LockHashAlgorithm c : LockHashAlgorithm.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static LockHashAlgorithm valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

rawValueOf

public static LockHashAlgorithm rawValueOf(int value)

validator

public static boolean validator(LockHashAlgorithm hashType,
                                java.lang.String input)

Validate hash algorithm and hash have desired format

Parameters:

hashType - Hash type

input - Input hashed

Returns:

boolean when format is correct

hash

public byte[] hash(byte[]... values)

Use this method to just hash values when the LockHashAlgorithmType is known. Users don't need to if/switch per algorithm.

Specified by:

hash in interface Hasher

Parameters:

values - the values to be hashed

Returns:

the hashed value using the algorithm.

getValue

public int getValue()