net.openhft.chronicle.hash.serialization

Interface BytesWriter<T>

Type Parameters:

T - the type of objects serialized

All Superinterfaces:

net.openhft.chronicle.bytes.CommonMarshallable, net.openhft.chronicle.wire.Marshallable, net.openhft.chronicle.wire.ReadMarshallable, net.openhft.chronicle.core.io.Resettable, net.openhft.chronicle.wire.WriteMarshallable, net.openhft.chronicle.wire.WriteValue

All Known Implementing Classes:

ListMarshaller, MapMarshaller, SetMarshaller

public interface BytesWriter<T>
extends net.openhft.chronicle.wire.Marshallable

Serializer of objects to bytes, pairing BytesReader.

Read BytesWriter and BytesReader and custom serialization checklist sections in the Chronicle Map tutorial for more information on this interface, how to implement and use it properly.

See Also:

BytesReader, ChronicleHashBuilder.keyMarshallers(BytesReader, BytesWriter), ChronicleMapBuilder.valueMarshallers(BytesReader, BytesWriter)

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
void	write(net.openhft.chronicle.bytes.Bytes out, T toWrite) Serializes the given object to the given out.

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

$equals, $fieldInfoMap, $fieldInfos, $hashCode, $toString, className, copyTo, deepCopy, fromFile, fromFile, fromString, fromString, fromString, getField, getLongField, mergeToMap, readMarshallable, reset, setField, setLongField, streamFromFile, streamFromFile, writeMarshallable

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

binaryLengthLength, writeValue

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

unexpectedField

Methods inherited from interface net.openhft.chronicle.bytes.CommonMarshallable

usesSelfDescribingMessage

Method Detail

write

void write(net.openhft.chronicle.bytes.Bytes out,
           @NotNull
           T toWrite)

Serializes the given object to the given out.

Implementation of this method should increment the position of the given out by the number of bytes written. The given object should be written into these range between the initial bytes' position and the position after this method call returns. Bytes outside of this range shouldn't be written. Any bytes shouldn't be read from out.

Parameters:

out - the Bytes to write the given object to

toWrite - the object to serialize