net.openhft.chronicle.bytes.algo

Enum OptimisedBytesStoreHash

java.lang.Object

java.lang.Enum<OptimisedBytesStoreHash>

net.openhft.chronicle.bytes.algo.OptimisedBytesStoreHash

All Implemented Interfaces:

Serializable, Comparable<OptimisedBytesStoreHash>, ToLongFunction<BytesStore>, BytesStoreHash<BytesStore>

public enum OptimisedBytesStoreHash
extends Enum<OptimisedBytesStoreHash>
implements BytesStoreHash<BytesStore>

Optimized hashing algorithm for BytesStore.

This enumeration implements BytesStoreHash for optimized hashing of BytesStore depending on the size of the data and architecture of the system.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	IS_LITTLE_ENDIAN
static net.openhft.chronicle.core.Memory	MEMORY

Method Summary

Modifier and Type	Method and Description
long	applyAsLong(@NotNull BytesStore store) Hashes a BytesStore.
long	applyAsLong(@NotNull BytesStore store, long remaining) Hashes a BytesStore of the given length.
static long	applyAsLong32bytesMultiple(@NotNull BytesStore store, int remaining) Computes a 64-bit hash value for the given BytesStore for data sizes that are multiple of 32 bytes.
static long	applyAsLongAny(@NotNull BytesStore store, long remaining) Computes a 64-bit hash value for the given BytesStore for any size of data.
static long	hash(long l) Performs a hash on a 64-bit long value.
static OptimisedBytesStoreHash	valueOf(String name) Returns the enum constant of this type with the specified name.
static OptimisedBytesStoreHash[]	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 OptimisedBytesStoreHash INSTANCE

Field Detail

MEMORY

public static final net.openhft.chronicle.core.Memory MEMORY

IS_LITTLE_ENDIAN

public static final boolean IS_LITTLE_ENDIAN

Method Detail

values

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

Returns:

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

valueOf

public static OptimisedBytesStoreHash 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

hash

public static long hash(long l)

Performs a hash on a 64-bit long value.

Parameters:

l - The long value to hash.

Returns:

A 64-bit hash value.

applyAsLong32bytesMultiple

public static long applyAsLong32bytesMultiple(@NotNull
                                              @NotNull BytesStore store,
                                              int remaining)
                                       throws BufferUnderflowException

Computes a 64-bit hash value for the given BytesStore for data sizes that are multiple of 32 bytes.

Parameters:

store - The BytesStore to compute the hash for.

remaining - The number of bytes to process.

Returns:

A 64-bit hash value.

Throws:

BufferUnderflowException - If there is not enough data.

applyAsLongAny

public static long applyAsLongAny(@NotNull
                                  @NotNull BytesStore store,
                                  long remaining)
                           throws BufferUnderflowException

Computes a 64-bit hash value for the given BytesStore for any size of data.

Parameters:

store - The BytesStore to compute the hash for.

remaining - The number of bytes to process.

Returns:

A 64-bit hash value.

Throws:

BufferUnderflowException - If there is not enough data.

applyAsLong

public long applyAsLong(@NotNull
                        @NotNull BytesStore store)

Hashes a BytesStore. This is an implementation of the BytesStoreHash interface.

Specified by:

applyAsLong in interface ToLongFunction<BytesStore>

Parameters:

store - the BytesStore to hash.

Returns:

the hash value.

applyAsLong

public long applyAsLong(@NotNull
                        @NotNull BytesStore store,
                        long remaining)
                 throws IllegalStateException,
                        BufferUnderflowException

Hashes a BytesStore of the given length. This is an implementation of the BytesStoreHash interface.

Specified by:

applyAsLong in interface BytesStoreHash<BytesStore>

Parameters:

store - the BytesStore to hash.

remaining - the length of content in BytesStore to hash.

Returns:

the hash value.

Throws:

IllegalStateException - if an illegal state is encountered.

BufferUnderflowException - if buffer underflows during reading.