Package org.apache.kafka.common.serialization

Class UUIDDeserializer

java.lang.Object

org.apache.kafka.common.serialization.UUIDDeserializer

All Implemented Interfaces:

Closeable, AutoCloseable, Deserializer<UUID>

public class UUIDDeserializer
extends Object
implements Deserializer<UUID>

We are converting the byte array to String before deserializing to UUID. String encoding defaults to UTF8 and can be customized by setting the property key.deserializer.encoding, value.deserializer.encoding or deserializer.encoding. The first two take precedence over the last.

Constructor Summary

Constructors

Constructor	Description
UUIDDeserializer()

Method Summary

Modifier and Type	Method	Description
void	configure(Map<String,?> configs, boolean isKey)	Configure this class.
UUID	deserialize(String topic, byte[] data)	Deserialize a record value from a byte array into a value or object.
UUID	deserialize(String topic, Headers headers, ByteBuffer data)	Deserialize a record value from a ByteBuffer into a value or object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.kafka.common.serialization.Deserializer

close, deserialize

Constructor Details

UUIDDeserializer

public UUIDDeserializer()

Method Details

configure

public void configure(Map<String,?> configs,
 boolean isKey)

Description copied from interface: Deserializer

Configure this class.

Specified by:

configure in interface Deserializer<UUID>

Parameters:

configs - configs in key/value pairs

isKey - whether the deserializer is used for the key or the value

deserialize

public UUID deserialize(String topic,
 byte[] data)

Description copied from interface: Deserializer

Deserialize a record value from a byte array into a value or object.

It is recommended to deserialize a null byte array to a null object.

Specified by:

deserialize in interface Deserializer<UUID>

Parameters:

topic - topic associated with the data

data - serialized bytes; may be null

Returns:

deserialized typed data; may be null

deserialize

public UUID deserialize(String topic,
 Headers headers,
 ByteBuffer data)

Description copied from interface: Deserializer

Deserialize a record value from a ByteBuffer into a value or object.

If ByteBufferDeserializer is used by an application, the application code cannot make any assumptions about the returned ByteBuffer like the position, limit, capacity, etc., or if it is backed by an array or not.

Similarly, if this method is overridden, the implementation cannot make any assumptions about the passed in ByteBuffer either.

It is recommended to deserialize a null ByteBuffer to a null object.

Note that the passed in Headers may be empty, but never null. The implementation is allowed to modify the passed in headers, as a side effect of deserialization. It is considered best practice to not delete or modify existing headers, but rather only add new ones.

Specified by:

deserialize in interface Deserializer<UUID>

Parameters:

topic - topic associated with the data

headers - headers associated with the record

data - serialized ByteBuffer; may be null

Returns:

deserialized typed data; may be null