org.apache.flink.core.io

Interface IOReadableWritable

All Known Subinterfaces:

CopyableValue<T>, DataDistribution, Key<T>, NormalizableKey<T>, ResettableValue<T>, Value

All Known Implementing Classes:

BlockInfo, BooleanValue, ByteValue, CharValue, CollectionSerializerConfigSnapshot, CompositeSerializer.ConfigSnapshot, CompositeTypeSerializerConfigSnapshot, Configuration, CopyableValueSerializer.CopyableValueSerializerConfigSnapshot, DelegatingConfiguration, DoubleValue, EitherSerializerConfigSnapshot, EnumSerializer.EnumSerializerConfigSnapshot, FloatValue, GenericArraySerializerConfigSnapshot, GenericTypeSerializerConfigSnapshot, IntValue, KryoRegistrationSerializerConfigSnapshot, KryoSerializer.KryoSerializerConfigSnapshot, ListValue, LongValue, MapSerializerConfigSnapshot, MapValue, NullValue, ParameterlessTypeSerializerConfig, Path, PojoSerializer.PojoSerializerConfigSnapshot, PostVersionedIOReadableWritable, Record, RowSerializer.RowSerializerConfigSnapshot, ShortValue, StringValue, TupleSerializerConfigSnapshot, TypeSerializerConfigSnapshot, TypeSerializerSerializationUtil.TypeSerializerSerializationProxy, UnmodifiableConfiguration, ValueSerializer.ValueSerializerConfigSnapshot, VersionedIOReadableWritable

@Public
public interface IOReadableWritable

This interface must be implemented by every class whose objects have to be serialized to their binary representation and vice-versa. In particular, records have to implement this interface in order to specify how their data can be transferred to a binary representation.

When implementing this Interface make sure that the implementing class has a default (zero-argument) constructor!

Method Summary

Modifier and Type	Method and Description
void	read(DataInputView in) Reads the object's internal data from the given data input view.
void	write(DataOutputView out) Writes the object's internal data to the given data output view.

Method Detail

write

void write(DataOutputView out)
    throws IOException

Writes the object's internal data to the given data output view.

Parameters:

out - the output view to receive the data.

Throws:

IOException - thrown if any error occurs while writing to the output stream

read

void read(DataInputView in)
   throws IOException

Reads the object's internal data from the given data input view.

Parameters:

in - the input view to read the data from

Throws:

IOException - thrown if any error occurs while reading from the input stream