org.apache.flink.api.scala.typeutils

Class ScalaCaseClassSerializerSnapshot<T extends scala.Product>

java.lang.Object

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

org.apache.flink.api.scala.typeutils.ScalaCaseClassSerializerSnapshot<T>

All Implemented Interfaces:

TypeSerializerSnapshot<T>

@Internal
public final class ScalaCaseClassSerializerSnapshot<T extends scala.Product>
extends CompositeTypeSerializerSnapshot<T,org.apache.flink.api.scala.typeutils.ScalaCaseClassSerializer<T>>

TypeSerializerSnapshot for ScalaCaseClassSerializer.

Constructor Summary

Constructors

Constructor and Description
ScalaCaseClassSerializerSnapshot() Used via reflection.
ScalaCaseClassSerializerSnapshot(org.apache.flink.api.scala.typeutils.ScalaCaseClassSerializer<T> serializerInstance) Used for the snapshot path.

Method Summary

Modifier and Type	Method and Description
protected org.apache.flink.api.scala.typeutils.ScalaCaseClassSerializer<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(org.apache.flink.api.scala.typeutils.ScalaCaseClassSerializer<T> outerSerializer) Gets the nested serializers from the outer serializer.
protected boolean	isOuterSnapshotCompatible(org.apache.flink.api.scala.typeutils.ScalaCaseClassSerializer<T> newSerializer) Checks whether the outer snapshot is compatible with a given new 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, readSnapshot, 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

ScalaCaseClassSerializerSnapshot

public ScalaCaseClassSerializerSnapshot()

Used via reflection.

ScalaCaseClassSerializerSnapshot

public ScalaCaseClassSerializerSnapshot(org.apache.flink.api.scala.typeutils.ScalaCaseClassSerializer<T> serializerInstance)

Used for the snapshot path.

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 scala.Product,org.apache.flink.api.scala.typeutils.ScalaCaseClassSerializer<T extends scala.Product>>

Returns:

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

getNestedSerializers

protected TypeSerializer<?>[] getNestedSerializers(org.apache.flink.api.scala.typeutils.ScalaCaseClassSerializer<T> outerSerializer)

Description copied from class: CompositeTypeSerializerSnapshot

Gets the nested serializers from the outer serializer.

Specified by:

getNestedSerializers in class CompositeTypeSerializerSnapshot<T extends scala.Product,org.apache.flink.api.scala.typeutils.ScalaCaseClassSerializer<T extends scala.Product>>

Parameters:

outerSerializer - the outer serializer.

Returns:

the nested serializers.

createOuterSerializerWithNestedSerializers

protected org.apache.flink.api.scala.typeutils.ScalaCaseClassSerializer<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 scala.Product,org.apache.flink.api.scala.typeutils.ScalaCaseClassSerializer<T extends scala.Product>>

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.isOuterSnapshotCompatible(TypeSerializer) needs to be implemented.

Overrides:

writeOuterSnapshot in class CompositeTypeSerializerSnapshot<T extends scala.Product,org.apache.flink.api.scala.typeutils.ScalaCaseClassSerializer<T extends scala.Product>>

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.isOuterSnapshotCompatible(TypeSerializer) needs to be implemented.

Overrides:

readOuterSnapshot in class CompositeTypeSerializerSnapshot<T extends scala.Product,org.apache.flink.api.scala.typeutils.ScalaCaseClassSerializer<T extends scala.Product>>

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

isOuterSnapshotCompatible

protected boolean isOuterSnapshotCompatible(org.apache.flink.api.scala.typeutils.ScalaCaseClassSerializer<T> newSerializer)

Description copied from class: CompositeTypeSerializerSnapshot

Checks whether the outer snapshot is compatible with a given new serializer.

The base implementation of this method just returns true, i.e. it assumes that the outer serializer only has nested serializers and no extra information, and therefore the result of the check must always be true. 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.readOuterSnapshot(int, DataInputView, ClassLoader) needs to be implemented.

Overrides:

isOuterSnapshotCompatible in class CompositeTypeSerializerSnapshot<T extends scala.Product,org.apache.flink.api.scala.typeutils.ScalaCaseClassSerializer<T extends scala.Product>>

Parameters:

newSerializer - the new serializer, which contains the new outer information to check against.

Returns:

a flag indicating whether or not the new serializer's outer information is compatible with the one written in this snapshot.