net.openhft.chronicle.hash.serialization

Interface SizedWriter<T>

Type Parameters:

T - the type of the object marshalled

All Superinterfaces:

Marshallable, ReadMarshallable, WriteMarshallable, WriteValue

public interface SizedWriter<T>
extends Marshallable

Serializer (object to bytes writer) which 1) knows the length of serialized form of any object before actual serialization 2) doesn't include that length in the serialized form itself, assuming it will be passed by the ChronicleHash into SizedReader.read(net.openhft.chronicle.bytes.Bytes, long, T) deserialization method.

Implementation example:

 class LongPair { long first, second; }

 enum LongPairArrayWriter
         implements SizedWriter<LongPair[]>, EnumMarshallable<LongPairArrayWriter> {
     INSTANCE;

     @Override
     public long size(@NotNull LongPair[] toWrite) {
         return toWrite.length * 16L;
     }

     @Override
     public void write(@NotNull Bytes out, long size,
             @NotNull LongPair[] toWrite) {
         for (LongPair pair : toWrite) {
             out.writeLong(pair.first);
             out.writeLong(pair.second);
         }
     }

     @Override
     public LongPairArrayWriter readResolve() {
         return INSTANCE;
     }
 }

See Also:

SizedReader

Field Summary

Fields inherited from interface net.openhft.chronicle.wire.WriteMarshallable

EMPTY

Fields inherited from interface net.openhft.chronicle.wire.ReadMarshallable

DISCARD

Method Summary

Modifier and Type	Method and Description
long	size(T toWrite) Returns the length (in bytes) of the serialized form of the given object.
void	write(Bytes out, long size, T toWrite) Serializes the given object to the given out, without writing the length of the serialized form itself.

Methods inherited from interface net.openhft.chronicle.wire.WriteMarshallable

writeMarshallable, writeValue

Methods inherited from interface net.openhft.chronicle.wire.ReadMarshallable

readMarshallable

Method Detail

size

long size(@NotNull
          T toWrite)

Returns the length (in bytes) of the serialized form of the given object. Serialization form in terms of this interface, i. e. how much bytes are written to out on write(out, size, toWrite) call.

Parameters:

toWrite - the object which serialized form length should be returned

Returns:

the length (in bytes) of the serialized form of the given object

write

void write(Bytes out,
           long size,
           @NotNull
           T toWrite)

Serializes the given object to the given out, without writing the length of the serialized form itself.

Implementation of this method should increment the position of the given out by size(toWrite). The given object should be written into these range between the initial bytes' position and the position after this method call returns.

Parameters:

out - the Bytes to write the given object to

size - the size, returned by size(Object) for the given toWrite object. it is given, because size might be needed during serialization, and it's computation has non-constant complexity, i. e. if serializing a CharSequence using variable-length encoding like UTF-8.

toWrite - the object to serialize

See Also:

SizedReader.read(Bytes, long, Object)