org.apache.storm.state

Class DefaultStateEncoder<K,V>

java.lang.Object

org.apache.storm.state.DefaultStateEncoder<K,V>

All Implemented Interfaces:

StateEncoder<K,V,byte[],byte[]>

public class DefaultStateEncoder<K,V>
extends Object
implements StateEncoder<K,V,byte[],byte[]>

Default state encoder class for encoding/decoding key values. This class assumes encoded types of key and value are both binary (byte array) due to keep backward compatibility.

Field Summary

Fields

Modifier and Type	Field and Description
static Serializer<com.google.common.base.Optional<byte[]>>	internalValueSerializer
static byte[]	TOMBSTONE

Constructor Summary

Constructors

Constructor and Description
DefaultStateEncoder(Serializer<K> keySerializer, Serializer<V> valueSerializer)

Method Summary

Modifier and Type	Method and Description
K	decodeKey(byte[] encodedKey) Decode key.
V	decodeValue(byte[] encodedValue) Decode value.
byte[]	encodeKey(K key) Encode key.
byte[]	encodeValue(V value) Encode value.
Serializer<K>	getKeySerializer()
byte[]	getTombstoneValue() Get the tombstone value (deletion mark).
Serializer<V>	getValueSerializer()

Methods inherited from class java.lang.Object

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

Field Detail

internalValueSerializer

public static final Serializer<com.google.common.base.Optional<byte[]>> internalValueSerializer

TOMBSTONE

public static final byte[] TOMBSTONE

Constructor Detail

DefaultStateEncoder

public DefaultStateEncoder(Serializer<K> keySerializer,
                           Serializer<V> valueSerializer)

Method Detail

getKeySerializer

public Serializer<K> getKeySerializer()

getValueSerializer

public Serializer<V> getValueSerializer()

encodeKey

public byte[] encodeKey(K key)

Description copied from interface: StateEncoder

Encode key.

Specified by:

encodeKey in interface StateEncoder<K,V,byte[],byte[]>

Parameters:

key - the value of key (K type)

Returns:

the encoded value of key (KENCODED type)

encodeValue

public byte[] encodeValue(V value)

Description copied from interface: StateEncoder

Encode value.

Specified by:

encodeValue in interface StateEncoder<K,V,byte[],byte[]>

Parameters:

value - the value of value (V type)

Returns:

the encoded value of value (VENCODED type)

decodeKey

public K decodeKey(byte[] encodedKey)

Description copied from interface: StateEncoder

Decode key.

Specified by:

decodeKey in interface StateEncoder<K,V,byte[],byte[]>

Parameters:

encodedKey - the value of key (KRAW type)

Returns:

the decoded value of key (K type)

decodeValue

public V decodeValue(byte[] encodedValue)

Description copied from interface: StateEncoder

Decode value.

Specified by:

decodeValue in interface StateEncoder<K,V,byte[],byte[]>

Parameters:

encodedValue - the value of key (VENCODED type)

Returns:

the decoded value of key (V type)

getTombstoneValue

public byte[] getTombstoneValue()

Description copied from interface: StateEncoder

Get the tombstone value (deletion mark).

Specified by:

getTombstoneValue in interface StateEncoder<K,V,byte[],byte[]>

Returns:

the tomestone value (VENCODED type)