Package com.scurrilous.circe

Enum Class HashSupport

java.lang.Object

java.lang.Enum<HashSupport>

com.scurrilous.circe.HashSupport

All Implemented Interfaces:

Serializable, Comparable<HashSupport>, Constable

public enum HashSupport
extends Enum<HashSupport>

Flags indicating the support available for some set of hash algorithm.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static final class	HashSupport.SetComparator	Comparator for EnumSets for hash support flags.

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
HARDWARE	Indicates that the hash algorithm is available in hardware-accelerated native code.
HARDWARE_INCREMENTAL	Indicates that the hash algorithm is available in hardware-accelerated native code as an IncrementalIntHash or IncrementalLongHash, depending on which of INT_SIZED or LONG_SIZED is set.
INCREMENTAL	Indicates that the hash algorithm is available as an incremental stateful hash function, for which StatefulHash.supportsIncremental() returns true.
INT_SIZED	Indicates that the hash algorithm is available as a StatefulIntHash and StatelessIntHash.
LONG_SIZED	Indicates that the hash algorithm is available as a StatefulLongHash and StatelessLongHash.
NATIVE	Indicates that the hash algorithm is available in native code.
NATIVE_INCREMENTAL	Indicates that the hash algorithm is available in native code as a IncrementalIntHash or IncrementalLongHash, depending on which of INT_SIZED or LONG_SIZED is set.
STATEFUL	Indicates that the hash algorithm is available as a StatefulHash.
STATELESS_INCREMENTAL	Indicates that the hash algorithm is available as a IncrementalIntHash or IncrementalLongHash, depending on which of INT_SIZED or LONG_SIZED is set.
UNSAFE	Indicates that the stateful hash algorithm unsafe memory access via StatefulHash.update(long, long).
UNSAFE_INCREMENTAL	Indicates that the incremental hash algorithm supports unsafe memory access via IncrementalIntHash.resume(int, long, long) or IncrementalLongHash.resume(long, long, long), depending on which of INT_SIZED or LONG_SIZED is set.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_PRIORITY	The maximum priority value, indicating the lowest priority.
static final int	MIN_PRIORITY	The minimum priority value, indicating the highest priority.

Method Summary

Modifier and Type	Method	Description
static int	compare(EnumSet<HashSupport> set1, EnumSet<HashSupport> set2)	Compares the given sets of hash algorithm support flags for priority order.
static int	getMaxPriority(EnumSet<HashSupport> set)	Returns the priority of the highest-priority hash algorithm support flag in the given set of flags.
int	getPriority()	Returns the relative priority of a hash algorithm support flag, which is an indicator of its performance and flexibility.
static HashSupport	valueOf(String name)	Returns the enum constant of this class with the specified name.
static HashSupport[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

HARDWARE_INCREMENTAL

public static final HashSupport HARDWARE_INCREMENTAL

Indicates that the hash algorithm is available in hardware-accelerated native code as an IncrementalIntHash or IncrementalLongHash, depending on which of INT_SIZED or LONG_SIZED is set.

HARDWARE

public static final HashSupport HARDWARE

Indicates that the hash algorithm is available in hardware-accelerated native code.

NATIVE_INCREMENTAL

public static final HashSupport NATIVE_INCREMENTAL

Indicates that the hash algorithm is available in native code as a IncrementalIntHash or IncrementalLongHash, depending on which of INT_SIZED or LONG_SIZED is set.

NATIVE

public static final HashSupport NATIVE

Indicates that the hash algorithm is available in native code.

UNSAFE_INCREMENTAL

public static final HashSupport UNSAFE_INCREMENTAL

Indicates that the incremental hash algorithm supports unsafe memory access via IncrementalIntHash.resume(int, long, long) or IncrementalLongHash.resume(long, long, long), depending on which of INT_SIZED or LONG_SIZED is set.

UNSAFE

public static final HashSupport UNSAFE

Indicates that the stateful hash algorithm unsafe memory access via StatefulHash.update(long, long). If INT_SIZED is also set, the function returned by StatefulIntHash.asStateless() also supports StatelessIntHash.calculate(long, long). Similarly, if LONG_SIZED is also set, the function returned by StatefulLongHash.asStateless() also supports StatelessLongHash.calculate(long, long).

STATELESS_INCREMENTAL

public static final HashSupport STATELESS_INCREMENTAL

Indicates that the hash algorithm is available as a IncrementalIntHash or IncrementalLongHash, depending on which of INT_SIZED or LONG_SIZED is set.

INCREMENTAL

public static final HashSupport INCREMENTAL

Indicates that the hash algorithm is available as an incremental stateful hash function, for which StatefulHash.supportsIncremental() returns true. This flag is implied by STATELESS_INCREMENTAL.

INT_SIZED

public static final HashSupport INT_SIZED

Indicates that the hash algorithm is available as a StatefulIntHash and StatelessIntHash.

LONG_SIZED

public static final HashSupport LONG_SIZED

Indicates that the hash algorithm is available as a StatefulLongHash and StatelessLongHash.

STATEFUL

public static final HashSupport STATEFUL

Indicates that the hash algorithm is available as a StatefulHash. If this flag is not set, the algorithm is not supported at all.

Field Details

MIN_PRIORITY

public static final int MIN_PRIORITY

The minimum priority value, indicating the highest priority. All flags have a priority value greater than this.

See Also:

• Constant Field Values

MAX_PRIORITY

public static final int MAX_PRIORITY

The maximum priority value, indicating the lowest priority. All flags have a priority value less than this.

See Also:

• Constant Field Values

Method Details

values

public static HashSupport[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static HashSupport valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getPriority

public int getPriority()

Returns the relative priority of a hash algorithm support flag, which is an indicator of its performance and flexibility. Lower values indicate higher priority.

Returns:

the priority of this flag (currently between 10 and 90)

getMaxPriority

public static int getMaxPriority(EnumSet<HashSupport> set)

Returns the priority of the highest-priority hash algorithm support flag in the given set of flags. If the set is empty, MAX_PRIORITY is returned.

Parameters:

set - a set of hash algorithm support flags

Returns:

the highest priority (lowest value) in the set, or MAX_PRIORITY if empty

compare

public static int compare(EnumSet<HashSupport> set1,
 EnumSet<HashSupport> set2)

Compares the given sets of hash algorithm support flags for priority order. The set with the highest priority flag without a flag of matching priority in the other set has higher priority.

Parameters:

set1 - the first set to be compared

set2 - the second set to be compared

Returns:

a negative integer, zero, or a positive integer if the first set has priority higher than, equal to, or lower than the second