org.apache.storm.state

Interface StateEncoder<K,V,KENCODED,VENCODED>

All Known Implementing Classes:

DefaultStateEncoder

public interface StateEncoder<K,V,KENCODED,VENCODED>

The interface of State Encoder.

Method Summary

Modifier and Type	Method and Description
K	decodeKey(KENCODED encodedKey) Decode key.
V	decodeValue(VENCODED encodedValue) Decode value.
KENCODED	encodeKey(K key) Encode key.
VENCODED	encodeValue(V value) Encode value.
VENCODED	getTombstoneValue() Get the tombstone value (deletion mark).

Method Detail

encodeKey

KENCODED encodeKey(K key)

Encode key.

Parameters:

key - the value of key (K type)

Returns:

the encoded value of key (KENCODED type)

encodeValue

VENCODED encodeValue(V value)

Encode value.

Parameters:

value - the value of value (V type)

Returns:

the encoded value of value (VENCODED type)

decodeKey

K decodeKey(KENCODED encodedKey)

Decode key.

Parameters:

encodedKey - the value of key (KRAW type)

Returns:

the decoded value of key (K type)

decodeValue

V decodeValue(VENCODED encodedValue)

Decode value.

Parameters:

encodedValue - the value of key (VENCODED type)

Returns:

the decoded value of key (V type)

getTombstoneValue

VENCODED getTombstoneValue()

Get the tombstone value (deletion mark).

Returns:

the tomestone value (VENCODED type)