org.apache.paimon.data.serializer

Class NullableSerializer<T>

java.lang.Object

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

All Implemented Interfaces:

Serializable, Serializer<T>

public class NullableSerializer<T>
extends Object
implements Serializer<T>

Serializer wrapper to add support of null value serialization.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static <T> boolean	checkIfNullSupported(Serializer<T> serializer) This method checks if serializer supports null value.
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.
Serializer<T>	duplicate() Creates a deep copy of this serializer if it is necessary, i.e.
boolean	equals(Object obj)
int	hashCode()
void	serialize(T record, DataOutputView target) Serializes the given record to the given target output view.
static <T> Serializer<T>	wrap(Serializer<T> originalSerializer) This method wraps the originalSerializer with the NullableSerializer if not already wrapped.
static <T> Serializer<T>	wrapIfNullIsNotSupported(Serializer<T> originalSerializer) This method tries to serialize null value with the originalSerializer and wraps it in case of NullPointerException, otherwise it returns the originalSerializer.

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

Method Detail

wrapIfNullIsNotSupported

public static <T> Serializer<T> wrapIfNullIsNotSupported(@Nonnull
                                                         Serializer<T> originalSerializer)

This method tries to serialize null value with the originalSerializer and wraps it in case of NullPointerException, otherwise it returns the originalSerializer.

Parameters:

originalSerializer - serializer to wrap and add null support

Returns:

serializer which supports null values

checkIfNullSupported

public static <T> boolean checkIfNullSupported(Serializer<T> serializer)

This method checks if serializer supports null value.

Parameters:

serializer - serializer to check

wrap

public static <T> Serializer<T> wrap(Serializer<T> originalSerializer)

This method wraps the originalSerializer with the NullableSerializer if not already wrapped.

Parameters:

originalSerializer - serializer to wrap and add null support

Returns:

wrapped serializer which supports null values

duplicate

public Serializer<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<T>

copy

public T copy(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<T>

Parameters:

from - The element reuse be copied.

Returns:

A deep copy of the element.

serialize

public void serialize(T record,
                      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<T>

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

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