org.apache.paimon.data.serializer

Interface Serializer<T>

All Superinterfaces:

Serializable

All Known Subinterfaces:

PagedTypeSerializer<T>

All Known Implementing Classes:

AbstractRowDataSerializer, BinaryRowSerializer, BinarySerializer, BinaryStringSerializer, BooleanSerializer, ByteSerializer, DecimalSerializer, DoubleSerializer, FloatSerializer, InternalArraySerializer, InternalMapSerializer, InternalRowSerializer, IntSerializer, ListSerializer, LongSerializer, NullableSerializer, PositiveIntIntSerializer, RowCompactedSerializer, SerializerSingleton, ShortSerializer, TimestampSerializer

public interface Serializer<T>
extends Serializable

Serializer to serialize internal data structure.

Method Summary

Modifier and Type	Method and Description
T	copy(T from) Creates a deep copy of the given element in a new element.
T	deserialize(DataInputView source) De-serializes a record from the given source input view.
default T	deserializeFromString(String s) De-serializes a record from string.
Serializer<T>	duplicate() Creates a deep copy of this serializer if it is necessary, i.e.
void	serialize(T record, DataOutputView target) Serializes the given record to the given target output view.
default String	serializeToString(T record) Serializes the given record to string.

Method Detail

duplicate

Serializer<T> duplicate()

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.

copy

T copy(T from)

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

Parameters:

from - The element reuse be copied.

Returns:

A deep copy of the element.

serialize

void serialize(T record,
               DataOutputView target)
        throws IOException

Serializes the given record to the given target output view.

Parameters:

record - 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

T deserialize(DataInputView source)
       throws IOException

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

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.

serializeToString

default String serializeToString(T record)

Serializes the given record to string.

Parameters:

record - The record to serialize.

Returns:

The serialized element.

deserializeFromString

default T deserializeFromString(String s)

De-serializes a record from string.

Parameters:

s - The string to de-serialize.

Returns:

The deserialized element.