com.scaleout.client.caching

Class StringKeyEncoder

java.lang.Object

com.scaleout.client.caching.KeyEncoder<java.lang.String>

com.scaleout.client.caching.StringKeyEncoder

public class StringKeyEncoder
extends KeyEncoder<java.lang.String>

The StringKeyEncoder is an implementation of a KeyEncoder for String keys that is not compatible with the SOSS-JNC API. To use String keys compatible with the SOSS-JNC API, use LegacyStringKeyEncoder.

Constructor Summary

Constructors

Constructor and Description
StringKeyEncoder(StringKeyCache stringKeyCache) Instantiate a string key encoder with a string key cache.

Method Summary

Modifier and Type	Method and Description
KeyEncodingResult	encode(java.lang.String key) Encodes the String key into a KeyEncodingResult with a UTF-8 encoded key string.
java.lang.String	fromBytes(byte[] keyAsBytes) Retrieves a UTF-8 string from the 32-byte encoded key string.

Methods inherited from class java.lang.Object

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

Constructor Detail

StringKeyEncoder

public StringKeyEncoder(StringKeyCache stringKeyCache)

Instantiate a string key encoder with a string key cache.

Parameters:

stringKeyCache - the string key cache.

Method Detail

fromBytes

public java.lang.String fromBytes(byte[] keyAsBytes)

Retrieves a UTF-8 string from the 32-byte encoded key string.

Specified by:

fromBytes in class KeyEncoder<java.lang.String>

Parameters:

keyAsBytes - the 32 byte encoded key

Returns:

the key string

encode

public KeyEncodingResult encode(java.lang.String key)

Encodes the String key into a KeyEncodingResult with a UTF-8 encoded key string.

Specified by:

encode in class KeyEncoder<java.lang.String>

Parameters:

key - the Integer key

Returns:

the KeyEncodingResult