org.apache.paimon.data.serializer

Class ListSerializer<T>

java.lang.Object

org.apache.paimon.data.serializer.ListSerializer<T>

Type Parameters:

T - The type of element in the list.

All Implemented Interfaces:

Serializable, Serializer<List<T>>

public final class ListSerializer<T>
extends Object
implements Serializer<List<T>>

A serializer for Lists. The serializer relies on an element serializer for the serialization of the list's elements.

The serialization format for the list is as follows: four bytes for the length of the lost, followed by the serialized representation of each element.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ListSerializer(Serializer<T> elementSerializer) Creates a list serializer that uses the given serializer to serialize the list's elements.

Method Summary

Modifier and Type	Method and Description
List<T>	copy(List<T> from) Creates a deep copy of the given element in a new element.
List<T>	deserialize(DataInputView source) De-serializes a record from the given source input view.
Serializer<List<T>>	duplicate() Creates a deep copy of this serializer if it is necessary, i.e.
boolean	equals(Object obj)
Serializer<T>	getElementSerializer() Gets the serializer for the elements of the list.
int	hashCode()
void	serialize(List<T> list, DataOutputView target) Serializes the given record to the given target output view.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.paimon.data.serializer.Serializer

deserializeFromString, serializeToString

Constructor Detail

ListSerializer

public ListSerializer(Serializer<T> elementSerializer)

Creates a list serializer that uses the given serializer to serialize the list's elements.

Parameters:

elementSerializer - The serializer for the elements of the list

Method Detail

getElementSerializer

public Serializer<T> getElementSerializer()

Gets the serializer for the elements of the list.

Returns:

The serializer for the elements of the list

duplicate

public Serializer<List<T>> duplicate()

Description copied from interface: Serializer

Creates a deep copy of this serializer if it is necessary, i.e. if it is stateful. This can return itself if the serializer is not stateful.

We need this because Serializers might be used in several threads. Stateless serializers are inherently thread-safe while stateful serializers might not be thread-safe.

Specified by:

duplicate in interface Serializer<List<T>>

copy

public List<T> copy(List<T> from)

Description copied from interface: Serializer

Creates a deep copy of the given element in a new element.

Specified by:

copy in interface Serializer<List<T>>

Parameters:

from - The element reuse be copied.

Returns:

A deep copy of the element.

serialize

public void serialize(List<T> list,
                      DataOutputView target)
               throws IOException

Description copied from interface: Serializer

Serializes the given record to the given target output view.

Specified by:

serialize in interface Serializer<List<T>>

Parameters:

list - The record to serialize.

target - The output view to write the serialized data to.

Throws:

IOException - Thrown, if the serialization encountered an I/O related error. Typically raised by the output view, which may have an underlying I/O channel to which it delegates.

deserialize

public List<T> deserialize(DataInputView source)
                    throws IOException

Description copied from interface: Serializer

De-serializes a record from the given source input view.

Specified by:

deserialize in interface Serializer<List<T>>

Parameters:

source - The input view from which to read the data.

Returns:

The deserialized element.

Throws:

IOException - Thrown, if the de-serialization encountered an I/O related error. Typically raised by the input view, which may have an underlying I/O channel from which it reads.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object