net.openhft.lang.io.serialization

Interface BytesMarshaller<E>

All Superinterfaces:

Serializable

All Known Subinterfaces:

CompactBytesMarshaller<E>

All Known Implementing Classes:

ByteBufferMarshaller, ByteBufferZMarshaller, BytesMarshallableMarshaller, ClassMarshaller, CompactEnumBytesMarshaller, DateMarshaller, EnumBytesMarshaller, ExternalizableMarshaller, GenericEnumMarshaller, ListMarshaller, MapMarshaller, NoMarshaller, SetMarshaller, SnappyStringMarshaller, StringMarshaller, StringZMapMarshaller

public interface BytesMarshaller<E>
extends Serializable

External marshaller for classes. From design patterns point of view, this interface is marshalling strategy.

Author:

peter.lawrey

See Also:

BytesMarshallable

Method Summary

Modifier and Type	Method and Description
E	read(Bytes bytes) Reads and returns an object from bytes.
E	read(Bytes bytes, E e) Reads and returns an object from bytes, reusing the given object, if possible.
void	write(Bytes bytes, E e) Write the object out to the bytes.

Method Detail

write

void write(Bytes bytes,
           E e)

Write the object out to the bytes.

Parameters:

bytes - to write to

e - the object to write

read

@Nullable
E read(Bytes bytes)

Reads and returns an object from bytes.

Parameters:

bytes - to read

Returns:

the read object

read

@Nullable
E read(Bytes bytes,
                 @Nullable
                 E e)

Reads and returns an object from bytes, reusing the given object, if possible.

Parameters:

bytes - to read

e - an object to reuse, if possible. null could be passed, in this case a new object should be allocated anyway.

Returns:

the read object