com.scaleout.client.caching

Class KeyEncoder<K>

java.lang.Object

com.scaleout.client.caching.KeyEncoder<K>

Type Parameters:

K - the key type

Direct Known Subclasses:

ByteArrayKeyEncoder, IntegerKeyEncoder, LegacyStringKeyEncoder, StringKeyEncoder, UuidKeyEncoder

public abstract class KeyEncoder<K>
extends java.lang.Object

The KeyEncoder is used to transform a K key into an array of 32 bytes.

Constructor Summary

Constructors

Constructor and Description
KeyEncoder() Construct a KeyEncoder.

Method Summary

Modifier and Type	Method and Description
abstract KeyEncodingResult	encode(K key) Encodes a K key into an array of 32-bytes.
abstract K	fromBytes(byte[] keyAsBytes) Retrieves a encoded key.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KeyEncoder

public KeyEncoder()

Construct a KeyEncoder.

Method Detail

fromBytes

public abstract K fromBytes(byte[] keyAsBytes)

Retrieves a encoded key.

Parameters:

keyAsBytes - the 32 byte encoded key

Returns:

the K key

encode

public abstract KeyEncodingResult encode(K key)

Encodes a K key into an array of 32-bytes.

Parameters:

key - the K key

Returns:

a KeyEncodingResult