org.apache.samza.serializers

Class KVSerde<K,V>

java.lang.Object

org.apache.samza.serializers.KVSerde<K,V>

Type Parameters:

K - type of the key in the message

V - type of the value in the message

All Implemented Interfaces:

java.io.Serializable, Deserializer<KV<K,V>>, Serde<KV<K,V>>, Serializer<KV<K,V>>

public class KVSerde<K,V>
extends java.lang.Object
implements Serde<KV<K,V>>

A serializer that serves one of the following two purposes:

1. When used for input/output streams, serves as an indication to the framework that messages are keyed and should be deserialized as K-V pairs.
2. When used for a key or value of type KV, serializes the key and value pair using the provided serdes.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
KVSerde(Serde<K> keySerde, Serde<V> valueSerde)

Method Summary

Modifier and Type	Method and Description
KV<K,V>	fromBytes(byte[] bytes) Deserializes given serialized object from an array of bytes to its original form.
Serde<K>	getKeySerde()
Serde<V>	getValueSerde()
static <K,V> KVSerde<K,V>	of(Serde<K> keySerde, Serde<V> valueSerde)
byte[]	toBytes(KV<K,V> obj) Serializes given object to an array of bytes.

Methods inherited from class java.lang.Object

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

Constructor Detail

KVSerde

public KVSerde(Serde<K> keySerde,
               Serde<V> valueSerde)

Method Detail

of

public static <K,V> KVSerde<K,V> of(Serde<K> keySerde,
                                    Serde<V> valueSerde)

fromBytes

public KV<K,V> fromBytes(byte[] bytes)

Description copied from interface: Deserializer

Deserializes given serialized object from an array of bytes to its original form.

Specified by:

fromBytes in interface Deserializer<KV<K,V>>

Parameters:

bytes - Array of bytes representing serialized object.

Returns:

Original deserialized object.

toBytes

public byte[] toBytes(KV<K,V> obj)

Description copied from interface: Serializer

Serializes given object to an array of bytes.

Specified by:

toBytes in interface Serializer<KV<K,V>>

Parameters:

obj - Object of specific type to serialize.

Returns:

An array of bytes representing the object in serialized form.

getKeySerde

public Serde<K> getKeySerde()

getValueSerde

public Serde<V> getValueSerde()