org.apache.flink.api.common.typeutils

Interface TypeDeserializer<T>

Type Parameters:

T - The data type that the deserializer deserializes.

All Known Implementing Classes:

AvroSerializer, BigDecSerializer, BigIntSerializer, BooleanPrimitiveArraySerializer, BooleanSerializer, BooleanValueSerializer, BytePrimitiveArraySerializer, ByteSerializer, ByteValueSerializer, CharPrimitiveArraySerializer, CharSerializer, CharValueSerializer, CopyableValueSerializer, DateSerializer, DoublePrimitiveArraySerializer, DoubleSerializer, DoubleValueSerializer, EitherSerializer, EnumSerializer, FloatPrimitiveArraySerializer, FloatSerializer, FloatValueSerializer, GenericArraySerializer, IntPrimitiveArraySerializer, IntSerializer, IntValueSerializer, KryoSerializer, ListSerializer, LongPrimitiveArraySerializer, LongSerializer, LongValueSerializer, MapSerializer, NullValueSerializer, PojoSerializer, RowSerializer, ShortPrimitiveArraySerializer, ShortSerializer, ShortValueSerializer, SqlDateSerializer, SqlTimeSerializer, SqlTimestampSerializer, StringArraySerializer, StringSerializer, StringValueSerializer, Tuple0Serializer, TupleSerializer, TupleSerializerBase, TypeDeserializerAdapter, TypeSerializer, TypeSerializerSingleton, UnloadableDummyTypeSerializer, ValueSerializer, VoidSerializer

public interface TypeDeserializer<T>

This interface describes the methods that are required for a data type to be read by the Flink runtime. Specifically, this interface contains the deserialization methods. In contrast, the TypeSerializer interface contains the complete set of methods for both serialization and deserialization.

The methods in this class are assumed to be stateless, such that it is effectively thread safe. Stateful implementations of the methods may lead to unpredictable side effects and will compromise both stability and correctness of the program.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canEqual(Object obj) Returns true if the given object can be equaled with this object.
T	deserialize(DataInputView source) De-serializes a record from the given source input view.
T	deserialize(T reuse, DataInputView source) De-serializes a record from the given source input view into the given reuse record instance if mutable.
TypeSerializer<T>	duplicate() Creates a deep copy of this deserializer if it is necessary, i.e.
boolean	equals(Object obj)
int	getLength() Gets the length of the data type, if it is a fix length data type.
int	hashCode()

Method Detail

duplicate

TypeSerializer<T> duplicate()

Creates a deep copy of this deserializer if it is necessary, i.e. if it is stateful. This can return itself if the serializer is not stateful. We need this because deserializers might be used in several threads. Stateless deserializers are inherently thread-safe while stateful deserializers might not be thread-safe.

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.

deserialize

T deserialize(T reuse,
            DataInputView source)
              throws IOException

De-serializes a record from the given source input view into the given reuse record instance if mutable.

Parameters:

reuse - The record instance into which to de-serialize the data.

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.

getLength

int getLength()

Gets the length of the data type, if it is a fix length data type.

Returns:

The length of the data type, or -1 for variable length data types.

canEqual

boolean canEqual(Object obj)

Returns true if the given object can be equaled with this object. If not, it returns false.

Parameters:

obj - Object which wants to take part in the equality relation

Returns:

true if obj can be equaled with this, otherwise false

equals

boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

int hashCode()

Overrides:

hashCode in class Object