net.openhft.chronicle.bytes.algo

Enum VanillaBytesStoreHash

java.lang.Object

java.lang.Enum<VanillaBytesStoreHash>

net.openhft.chronicle.bytes.algo.VanillaBytesStoreHash

All Implemented Interfaces:

Serializable, Comparable<VanillaBytesStoreHash>, ToLongFunction<BytesStore<?,?>>, BytesStoreHash<BytesStore<?,?>>

public enum VanillaBytesStoreHash
extends Enum<VanillaBytesStoreHash>
implements BytesStoreHash<BytesStore<?,?>>

This enum provides hashing functionality for byte stores. Hashing is a process of converting data of arbitrary size to fixed-size values.

See Also:

BytesStoreHash, BytesStore

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE Singleton instance of VanillaBytesStoreHash.

Method Summary

Modifier and Type	Method and Description
static long	agitate(long l) Agitates the given long value to generate a hash value.
long	applyAsLong(@NotNull BytesStore<?,?> store) Computes a 64-bit hash value for the given BytesStore.
long	applyAsLong(BytesStore<?,?> bytes, long length) Computes a 64-bit hash value for the given BytesStore.
static VanillaBytesStoreHash	valueOf(String name) Returns the enum constant of this type with the specified name.
static VanillaBytesStoreHash[]	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

Methods inherited from interface net.openhft.chronicle.bytes.algo.BytesStoreHash

hash, hash, hash32, hash32

Enum Constant Detail

INSTANCE

public static final VanillaBytesStoreHash INSTANCE

Singleton instance of VanillaBytesStoreHash.

Method Detail

values

public static VanillaBytesStoreHash[] 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 (VanillaBytesStoreHash c : VanillaBytesStoreHash.values())
    System.out.println(c);

Returns:

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

valueOf

public static VanillaBytesStoreHash valueOf(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:

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

NullPointerException - if the argument is null

agitate

public static long agitate(long l)

Agitates the given long value to generate a hash value.

Parameters:

l - The input value.

Returns:

The agitated hash value.

applyAsLong

public long applyAsLong(@NotNull
                        @NotNull BytesStore<?,?> store)

Computes a 64-bit hash value for the given BytesStore.

Specified by:

applyAsLong in interface ToLongFunction<BytesStore<?,?>>

Parameters:

store - The BytesStore to compute the hash for.

Returns:

A 64-bit hash value.

Throws:

BufferUnderflowException - If there is not enough data.

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

applyAsLong

public long applyAsLong(BytesStore<?,?> bytes,
                        long length)
                 throws IllegalStateException,
                        BufferUnderflowException

Computes a 64-bit hash value for the given BytesStore.

Specified by:

applyAsLong in interface BytesStoreHash<BytesStore<?,?>>

Parameters:

bytes - The BytesStore to compute the hash for.

length - The number of bytes to process.

Returns:

A 64-bit hash value.

Throws:

BufferUnderflowException - If there is not enough data.

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException