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

Class TupleSerializerSnapshot<T extends Tuple>

java.lang.Object

org.apache.flink.api.common.typeutils.CompositeTypeSerializerSnapshot<T,TupleSerializer<T>>

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

All Implemented Interfaces:

TypeSerializerSnapshot<T>

@Internal
public final class TupleSerializerSnapshot<T extends Tuple>
extends CompositeTypeSerializerSnapshot<T,TupleSerializer<T>>

Snapshot of a tuple serializer's configuration.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.flink.api.common.typeutils.CompositeTypeSerializerSnapshot

CompositeTypeSerializerSnapshot.OuterSchemaCompatibility

Constructor Summary

Constructors

Constructor and Description
TupleSerializerSnapshot()

Method Summary

Modifier and Type	Method and Description
protected TupleSerializer<T>	createOuterSerializerWithNestedSerializers(TypeSerializer<?>[] nestedSerializers) Creates an instance of the outer serializer with a given array of its nested serializers.
protected int	getCurrentOuterSnapshotVersion() Returns the version of the current outer snapshot's written binary format.
protected TypeSerializer<?>[]	getNestedSerializers(TupleSerializer<T> outerSerializer) Gets the nested serializers from the outer serializer.
protected void	readOuterSnapshot(int readOuterSnapshotVersion, DataInputView in, ClassLoader userCodeClassLoader) Reads the outer snapshot, i.e.
protected void	writeOuterSnapshot(DataOutputView out) Writes the outer snapshot, i.e.

Methods inherited from class org.apache.flink.api.common.typeutils.CompositeTypeSerializerSnapshot

getCurrentVersion, getNestedSerializerSnapshots, isOuterSnapshotCompatible, readSnapshot, resolveOuterSchemaCompatibility, resolveSchemaCompatibility, restoreSerializer, writeSnapshot

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.api.common.typeutils.TypeSerializerSnapshot

readVersionedSnapshot, writeVersionedSnapshot

Constructor Detail

TupleSerializerSnapshot

public TupleSerializerSnapshot()

Method Detail

getCurrentOuterSnapshotVersion

protected int getCurrentOuterSnapshotVersion()

Description copied from class: CompositeTypeSerializerSnapshot

Returns the version of the current outer snapshot's written binary format.

Specified by:

getCurrentOuterSnapshotVersion in class CompositeTypeSerializerSnapshot<T extends Tuple,TupleSerializer<T extends Tuple>>

Returns:

the version of the current outer snapshot's written binary format.

getNestedSerializers

protected TypeSerializer<?>[] getNestedSerializers(TupleSerializer<T> outerSerializer)

Description copied from class: CompositeTypeSerializerSnapshot

Gets the nested serializers from the outer serializer.

Specified by:

getNestedSerializers in class CompositeTypeSerializerSnapshot<T extends Tuple,TupleSerializer<T extends Tuple>>

Parameters:

outerSerializer - the outer serializer.

Returns:

the nested serializers.

createOuterSerializerWithNestedSerializers

protected TupleSerializer<T> createOuterSerializerWithNestedSerializers(TypeSerializer<?>[] nestedSerializers)

Description copied from class: CompositeTypeSerializerSnapshot

Creates an instance of the outer serializer with a given array of its nested serializers.

Specified by:

createOuterSerializerWithNestedSerializers in class CompositeTypeSerializerSnapshot<T extends Tuple,TupleSerializer<T extends Tuple>>

Parameters:

nestedSerializers - array of nested serializers to create the outer serializer with.

Returns:

an instance of the outer serializer.

writeOuterSnapshot

protected void writeOuterSnapshot(DataOutputView out)
                           throws IOException

Description copied from class: CompositeTypeSerializerSnapshot

Writes the outer snapshot, i.e. any information beyond the nested serializers of the outer serializer.

The base implementation of this methods writes nothing, i.e. it assumes that the outer serializer only has nested serializers and no extra information. Otherwise, if the outer serializer contains some extra information that needs to be persisted as part of the serializer snapshot, this must be overridden. Note that this method and the corresponding methods CompositeTypeSerializerSnapshot.readOuterSnapshot(int, DataInputView, ClassLoader), CompositeTypeSerializerSnapshot.resolveOuterSchemaCompatibility(TypeSerializer) needs to be implemented.

Overrides:

writeOuterSnapshot in class CompositeTypeSerializerSnapshot<T extends Tuple,TupleSerializer<T extends Tuple>>

Parameters:

out - the DataOutputView to write the outer snapshot to.

Throws:

IOException

readOuterSnapshot

protected void readOuterSnapshot(int readOuterSnapshotVersion,
                                 DataInputView in,
                                 ClassLoader userCodeClassLoader)
                          throws IOException

Description copied from class: CompositeTypeSerializerSnapshot

Reads the outer snapshot, i.e. any information beyond the nested serializers of the outer serializer.

The base implementation of this methods reads nothing, i.e. it assumes that the outer serializer only has nested serializers and no extra information. Otherwise, if the outer serializer contains some extra information that has been persisted as part of the serializer snapshot, this must be overridden. Note that this method and the corresponding methods CompositeTypeSerializerSnapshot.writeOuterSnapshot(DataOutputView), CompositeTypeSerializerSnapshot.resolveOuterSchemaCompatibility(TypeSerializer) needs to be implemented.

Overrides:

readOuterSnapshot in class CompositeTypeSerializerSnapshot<T extends Tuple,TupleSerializer<T extends Tuple>>

Parameters:

readOuterSnapshotVersion - the read version of the outer snapshot.

in - the DataInputView to read the outer snapshot from.

userCodeClassLoader - the user code class loader.

Throws:

IOException