org.apache.flink.core.io

Class SimpleVersionedSerialization

java.lang.Object

org.apache.flink.core.io.SimpleVersionedSerialization

@PublicEvolving
public class SimpleVersionedSerialization
extends Object

Simple serialization / deserialization methods for the SimpleVersionedSerializer.

Method Summary

Modifier and Type	Method and Description
static <T> T	readVersionAndDeSerialize(SimpleVersionedSerializer<T> serializer, byte[] bytes) Deserializes the version and datum from a byte array.
static <T> T	readVersionAndDeSerialize(SimpleVersionedSerializer<T> serializer, DataInputView in) Deserializes the version and datum from a stream.
static <T> byte[]	writeVersionAndSerialize(SimpleVersionedSerializer<T> serializer, T datum) Serializes the version and datum into a byte array.
static <T> void	writeVersionAndSerialize(SimpleVersionedSerializer<T> serializer, T datum, DataOutputView out) Serializes the version and datum into a stream.

Methods inherited from class java.lang.Object

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

Method Detail

writeVersionAndSerialize

public static <T> void writeVersionAndSerialize(SimpleVersionedSerializer<T> serializer,
                                                T datum,
                                                DataOutputView out)
                                         throws IOException

Serializes the version and datum into a stream.

Data serialized via this method can be deserialized via readVersionAndDeSerialize(SimpleVersionedSerializer, DataInputView).

The first four bytes will be occupied by the version, as returned by SimpleVersionedSerializer.getVersion(). The remaining bytes will be the serialized datum, as produced by SimpleVersionedSerializer.serialize(Object), plus its length. The resulting array will hence be eight bytes larger than the serialized datum.

Parameters:

serializer - The serializer to serialize the datum with.

datum - The datum to serialize.

out - The stream to serialize to.

Throws:

IOException

readVersionAndDeSerialize

public static <T> T readVersionAndDeSerialize(SimpleVersionedSerializer<T> serializer,
                                              DataInputView in)
                                       throws IOException

Deserializes the version and datum from a stream.

This method deserializes data serialized via writeVersionAndSerialize(SimpleVersionedSerializer, Object, DataOutputView).

The first four bytes will be interpreted as the version. The next four bytes will be interpreted as the length of the datum bytes, then length-many bytes will be read. Finally, the datum is deserialized via the SimpleVersionedSerializer.deserialize(int, byte[]) method.

Parameters:

serializer - The serializer to serialize the datum with.

in - The stream to deserialize from.

Throws:

IOException

writeVersionAndSerialize

public static <T> byte[] writeVersionAndSerialize(SimpleVersionedSerializer<T> serializer,
                                                  T datum)
                                           throws IOException

Serializes the version and datum into a byte array. The first four bytes will be occupied by the version (as returned by SimpleVersionedSerializer.getVersion()), written in big-endian encoding. The remaining bytes will be the serialized datum, as produced by SimpleVersionedSerializer.serialize(Object). The resulting array will hence be four bytes larger than the serialized datum.

Data serialized via this method can be deserialized via readVersionAndDeSerialize(SimpleVersionedSerializer, byte[]).

Parameters:

serializer - The serializer to serialize the datum with.

datum - The datum to serialize.

Returns:

A byte array containing the serialized version and serialized datum.

Throws:

IOException - Exceptions from the SimpleVersionedSerializer.serialize(Object) method are forwarded.

readVersionAndDeSerialize

public static <T> T readVersionAndDeSerialize(SimpleVersionedSerializer<T> serializer,
                                              byte[] bytes)
                                       throws IOException

Deserializes the version and datum from a byte array. The first four bytes will be read as the version, in big-endian encoding. The remaining bytes will be passed to the serializer for deserialization, via SimpleVersionedSerializer.deserialize(int, byte[]).

Parameters:

serializer - The serializer to deserialize the datum with.

bytes - The bytes to deserialize from.

Returns:

The deserialized datum.

Throws:

IOException - Exceptions from the SimpleVersionedSerializer.deserialize(int, byte[]) method are forwarded.