org.apache.flink.runtime.io.network.api.serialization

Class SpanningRecordSerializer<T extends org.apache.flink.core.io.IOReadableWritable>

java.lang.Object

org.apache.flink.runtime.io.network.api.serialization.SpanningRecordSerializer<T>

Type Parameters:

T - The type of the records that are serialized.

All Implemented Interfaces:

RecordSerializer<T>

public class SpanningRecordSerializer<T extends org.apache.flink.core.io.IOReadableWritable>
extends Object
implements RecordSerializer<T>

Record serializer which serializes the complete record to an intermediate data serialization buffer and copies this buffer to target buffers one-by-one using copyToBufferBuilder(BufferBuilder).

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.runtime.io.network.api.serialization.RecordSerializer

RecordSerializer.SerializationResult

Constructor Summary

Constructors

Constructor and Description
SpanningRecordSerializer()

Method Summary

Modifier and Type	Method and Description
RecordSerializer.SerializationResult	copyToBufferBuilder(BufferBuilder targetBuffer) Copies an intermediate data serialization buffer into the target BufferBuilder.
boolean	hasSerializedData()
void	prune() Clears the buffer and checks to decrease the size of intermediate data serialization buffer after finishing the whole serialization process including RecordSerializer.serializeRecord(IOReadableWritable) and RecordSerializer.copyToBufferBuilder(BufferBuilder).
void	reset() Supports copying an intermediate data serialization buffer to multiple target buffers by resetting its initial position before each copying.
void	serializeRecord(T record) Serializes the complete record to an intermediate data serialization buffer.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpanningRecordSerializer

public SpanningRecordSerializer()

Method Detail

serializeRecord

public void serializeRecord(T record)
                     throws IOException

Serializes the complete record to an intermediate data serialization buffer.

Specified by:

serializeRecord in interface RecordSerializer<T extends org.apache.flink.core.io.IOReadableWritable>

Parameters:

record - the record to serialize

Throws:

IOException

copyToBufferBuilder

public RecordSerializer.SerializationResult copyToBufferBuilder(BufferBuilder targetBuffer)

Copies an intermediate data serialization buffer into the target BufferBuilder.

Specified by:

copyToBufferBuilder in interface RecordSerializer<T extends org.apache.flink.core.io.IOReadableWritable>

Parameters:

targetBuffer - the target BufferBuilder to copy to

Returns:

how much information was written to the target buffer and whether this buffer is full

reset

public void reset()

Description copied from interface: RecordSerializer

Supports copying an intermediate data serialization buffer to multiple target buffers by resetting its initial position before each copying.

Specified by:

reset in interface RecordSerializer<T extends org.apache.flink.core.io.IOReadableWritable>

prune

public void prune()

Description copied from interface: RecordSerializer

Clears the buffer and checks to decrease the size of intermediate data serialization buffer after finishing the whole serialization process including RecordSerializer.serializeRecord(IOReadableWritable) and RecordSerializer.copyToBufferBuilder(BufferBuilder).

Specified by:

prune in interface RecordSerializer<T extends org.apache.flink.core.io.IOReadableWritable>

hasSerializedData

public boolean hasSerializedData()

Specified by:

hasSerializedData in interface RecordSerializer<T extends org.apache.flink.core.io.IOReadableWritable>

Returns:

true if has some serialized data pending copying to the result BufferBuilder.