StringKeyEncoder (scaleout-client 1.0.1 API)

java.lang.Object

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

com.scaleout.client.caching.StringKeyEncoder

public class StringKeyEncoder extends KeyEncoder<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

Description

StringKeyEncoder(StringKeyCache stringKeyCache)

Instantiate a string key encoder with a string key cache.
Method Summary

Modifier and Type

Method

Description

KeyEncodingResult

encode(String key)

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

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 Details
- StringKeyEncoder
  
  public StringKeyEncoder(StringKeyCache stringKeyCache)
  
  Instantiate a string key encoder with a string key cache.
  
  Parameters:
  
  stringKeyCache - the string key cache.
Method Details
- fromBytes
  
  public String fromBytes(byte[] keyAsBytes)
  
  Retrieves a UTF-8 string from the 32-byte encoded key string.
  
  Specified by:
  
  fromBytes in class KeyEncoder<String>
  
  Parameters:
  
  keyAsBytes - the 32 byte encoded key
  
  Returns:
  
  the key string
- encode
  
  public KeyEncodingResult encode(String key)
  
  Encodes the String key into a KeyEncodingResult with a UTF-8 encoded key string.
  
  Specified by:
  
  encode in class KeyEncoder<String>
  
  Parameters:
  
  key - the Integer key
  
  Returns:
  
  the KeyEncodingResult