org.apache.flink.api.java.typeutils.runtime

Class Tuple0Serializer

java.lang.Object

org.apache.flink.api.common.typeutils.TypeSerializer<T>

org.apache.flink.api.java.typeutils.runtime.TupleSerializerBase<T>

org.apache.flink.api.java.typeutils.runtime.TupleSerializer<Tuple0>

org.apache.flink.api.java.typeutils.runtime.Tuple0Serializer

All Implemented Interfaces:

Serializable, TypeSerializerConfigSnapshot.SelfResolvingTypeSerializer<Tuple0>

@Internal
public class Tuple0Serializer
extends TupleSerializer<Tuple0>
implements TypeSerializerConfigSnapshot.SelfResolvingTypeSerializer<Tuple0>

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Tuple0Serializer	INSTANCE

Fields inherited from class org.apache.flink.api.java.typeutils.runtime.TupleSerializerBase

arity, fieldSerializers, tupleClass

Method Summary

Modifier and Type	Method and Description
void	copy(DataInputView source, DataOutputView target) Copies exactly one record from the source input view to the target output view.
Tuple0	copy(Tuple0 from) Creates a deep copy of the given element in a new element.
Tuple0	copy(Tuple0 from, Tuple0 reuse) Creates a copy from the given element.
Tuple0	createInstance() Creates a new instance of the data type.
Tuple0	createInstance(Object[] fields)
Tuple0	deserialize(DataInputView source) De-serializes a record from the given source input view.
Tuple0	deserialize(Tuple0 reuse, DataInputView source) De-serializes a record from the given source input view into the given reuse record instance if mutable.
Tuple0Serializer	duplicate() Creates a deep copy of this serializer 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()
TypeSerializerSchemaCompatibility<Tuple0>	resolveSchemaCompatibilityViaRedirectingToNewSnapshotClass(TypeSerializerConfigSnapshot<Tuple0> deprecatedConfigSnapshot) Resolve Schema Compatibility.
void	serialize(Tuple0 record, DataOutputView target) Serializes the given record to the given target output view.
TypeSerializerSnapshot<Tuple0>	snapshotConfiguration() Snapshots the configuration of this TypeSerializer.
String	toString()

Methods inherited from class org.apache.flink.api.java.typeutils.runtime.TupleSerializer

createOrReuseInstance

Methods inherited from class org.apache.flink.api.java.typeutils.runtime.TupleSerializerBase

getArity, getFieldSerializers, getTupleClass, isImmutableType

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final Tuple0Serializer INSTANCE

Method Detail

duplicate

public Tuple0Serializer duplicate()

Description copied from class: TypeSerializer

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.

Overrides:

duplicate in class TupleSerializer<Tuple0>

createInstance

public Tuple0 createInstance()

Description copied from class: TypeSerializer

Creates a new instance of the data type.

Overrides:

createInstance in class TupleSerializer<Tuple0>

Returns:

A new instance of the data type.

createInstance

public Tuple0 createInstance(Object[] fields)

Overrides:

createInstance in class TupleSerializer<Tuple0>

copy

public Tuple0 copy(Tuple0 from)

Description copied from class: TypeSerializer

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

Overrides:

copy in class TupleSerializer<Tuple0>

Parameters:

from - The element reuse be copied.

Returns:

A deep copy of the element.

copy

public Tuple0 copy(Tuple0 from,
                   Tuple0 reuse)

Description copied from class: TypeSerializer

Creates a copy from the given element. The method makes an attempt to store the copy in the given reuse element, if the type is mutable. This is, however, not guaranteed.

Overrides:

copy in class TupleSerializer<Tuple0>

Parameters:

from - The element to be copied.

reuse - The element to be reused. May or may not be used.

Returns:

A deep copy of the element.

getLength

public int getLength()

Description copied from class: TypeSerializer

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

Overrides:

getLength in class TupleSerializerBase<Tuple0>

Returns:

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

serialize

public void serialize(Tuple0 record,
                      DataOutputView target)
               throws IOException

Description copied from class: TypeSerializer

Serializes the given record to the given target output view.

Overrides:

serialize in class TupleSerializer<Tuple0>

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 Tuple0 deserialize(DataInputView source)
                   throws IOException

Description copied from class: TypeSerializer

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

Overrides:

deserialize in class TupleSerializer<Tuple0>

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

public Tuple0 deserialize(Tuple0 reuse,
                          DataInputView source)
                   throws IOException

Description copied from class: TypeSerializer

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

Overrides:

deserialize in class TupleSerializer<Tuple0>

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.

copy

public void copy(DataInputView source,
                 DataOutputView target)
          throws IOException

Description copied from class: TypeSerializer

Copies exactly one record from the source input view to the target output view. Whether this operation works on binary data or partially de-serializes the record to determine its length (such as for records of variable length) is up to the implementer. Binary copies are typically faster. A copy of a record containing two integer numbers (8 bytes total) is most efficiently implemented as target.write(source, 8);.

Overrides:

copy in class TupleSerializerBase<Tuple0>

Parameters:

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

target - The target output view to which to write the record.

Throws:

IOException - Thrown if any of the two views raises an exception.

snapshotConfiguration

public TypeSerializerSnapshot<Tuple0> snapshotConfiguration()

Description copied from class: TypeSerializer

Snapshots the configuration of this TypeSerializer. This method is only relevant if the serializer is used to state stored in checkpoints/savepoints.

The snapshot of the TypeSerializer is supposed to contain all information that affects the serialization format of the serializer. The snapshot serves two purposes: First, to reproduce the serializer when the checkpoint/savepoint is restored, and second, to check whether the serialization format is compatible with the serializer used in the restored program.

IMPORTANT: TypeSerializerSnapshots changed after Flink 1.6. Serializers implemented against Flink versions up to 1.6 should still work, but adjust to new model to enable state evolution and be future-proof. See the class-level comments, section "Upgrading TypeSerializers to the new TypeSerializerSnapshot model" for details.

Overrides:

snapshotConfiguration in class TupleSerializer<Tuple0>

Returns:

snapshot of the serializer's current configuration (cannot be null).

See Also:

TypeSerializerSnapshot.resolveSchemaCompatibility(TypeSerializer)

hashCode

public int hashCode()

Overrides:

hashCode in class TupleSerializerBase<Tuple0>

equals

public boolean equals(Object obj)

Overrides:

equals in class TupleSerializerBase<Tuple0>

toString

public String toString()

Overrides:

toString in class Object

resolveSchemaCompatibilityViaRedirectingToNewSnapshotClass

public TypeSerializerSchemaCompatibility<Tuple0> resolveSchemaCompatibilityViaRedirectingToNewSnapshotClass(TypeSerializerConfigSnapshot<Tuple0> deprecatedConfigSnapshot)

Description copied from interface: TypeSerializerConfigSnapshot.SelfResolvingTypeSerializer

Resolve Schema Compatibility.

Given an instance of a TypeSerializerConfigSnapshot this method should redirect the compatibility check to the new TypeSerializerSnapshot class along with the relevant information as present in the given deprecatedConfigSnapshot.

Specified by:

resolveSchemaCompatibilityViaRedirectingToNewSnapshotClass in interface TypeSerializerConfigSnapshot.SelfResolvingTypeSerializer<Tuple0>

Overrides:

resolveSchemaCompatibilityViaRedirectingToNewSnapshotClass in class TupleSerializer<Tuple0>

Parameters:

deprecatedConfigSnapshot - the not yet migrated config snapshot class.

Returns:

the compatibility result of the deprecatedConfigSnapshot with this serializer.