Package org.apache.kafka.common.serialization

Class ListSerializer<Inner>

java.lang.Object

org.apache.kafka.common.serialization.ListSerializer<Inner>

All Implemented Interfaces:

Closeable, AutoCloseable, Serializer<List<Inner>>

public class ListSerializer<Inner>
extends Object
implements Serializer<List<Inner>>

Constructor Summary

Constructors

Constructor	Description
ListSerializer()
ListSerializer(Serializer<Inner> inner)

Method Summary

Modifier and Type	Method	Description
void	close()	Close this serializer.
void	configure(Map<String,?> configs, boolean isKey)	Configure this class.
Serializer<Inner>	getInnerSerializer()
byte[]	serialize(String topic, List<Inner> data)	Convert data into a byte array.
byte[]	serialize(String topic, Headers headers, List<Inner> data)	Convert data into a byte array.

Methods inherited from class java.lang.Object

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

Constructor Details

ListSerializer

public ListSerializer()

ListSerializer

public ListSerializer(Serializer<Inner> inner)

Method Details

getInnerSerializer

public Serializer<Inner> getInnerSerializer()

configure

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

Description copied from interface: Serializer

Configure this class.

Specified by:

configure in interface Serializer<Inner>

Parameters:

configs - configs in key/value pairs

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

serialize

public byte[] serialize(String topic,
 List<Inner> data)

Description copied from interface: Serializer

Convert data into a byte array.

It is recommended to serialize null data to the null byte array.

Specified by:

serialize in interface Serializer<Inner>

Parameters:

topic - topic associated with data

data - typed data; may be null

Returns:

serialized bytes; may be null

serialize

public byte[] serialize(String topic,
 Headers headers,
 List<Inner> data)

Description copied from interface: Serializer

Convert data into a byte array.

It is recommended to serialize null data to the null byte array.

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 serialization. It is considered best practice to not delete or modify existing headers, but rather only add new ones.

Specified by:

serialize in interface Serializer<Inner>

Parameters:

topic - topic associated with data

headers - headers associated with the record

data - typed data; may be null

Returns:

serialized bytes; may be null

close

public void close()

Description copied from interface: Serializer

Close this serializer.

This method must be idempotent as it may be called multiple times.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface Serializer<Inner>