net.openhft.chronicle.hash.serialization

Class MapMarshaller<K,V>

java.lang.Object

net.openhft.chronicle.hash.serialization.MapMarshaller<K,V>

Type Parameters:

K - the key type of serialized Maps

V - the value type of serialized Maps

All Implemented Interfaces:

net.openhft.chronicle.bytes.CommonMarshallable, net.openhft.chronicle.core.io.Resettable, BytesReader<Map<K,V>>, BytesWriter<Map<K,V>>, StatefulCopyable<MapMarshaller<K,V>>, net.openhft.chronicle.wire.Marshallable, net.openhft.chronicle.wire.ReadMarshallable, net.openhft.chronicle.wire.WriteMarshallable, net.openhft.chronicle.wire.WriteValue

public final class MapMarshaller<K,V>
extends Object
implements BytesReader<Map<K,V>>, BytesWriter<Map<K,V>>, StatefulCopyable<MapMarshaller<K,V>>

Marshaller of Map<K, V>. Uses HashMap (hence default key objects' equality and hashCode() as the map implementation to deserialize into.

This marshaller supports multimap emulation on top of Chronicle Map, that is possible but inefficient. See the README section.

Look for pre-defined key and value marshallers in the net.openhft.chronicle.hash.serialization.impl package. This package is not included into Javadocs, but present in Chronicle Map distribution. If there are no existing marshallers for your Map key or value types, define BytesReader and BytesWriter yourself.

See Also:

ListMarshaller, SetMarshaller

Field Summary

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

EMPTY

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

DISCARD

Constructor Summary

Constructors

Constructor and Description
MapMarshaller(BytesReader<K> keyReader, BytesWriter<? super K> keyWriter, BytesReader<V> valueReader, BytesWriter<? super V> valueWriter) Constructs a MapMarshaller with the given map keys' and values' serializers.

Method Summary

Modifier and Type	Method and Description
MapMarshaller<K,V>	copy() Creates a copy of this marshaller, with independent state.
Map<K,V>	read(net.openhft.chronicle.bytes.Bytes in, Map<K,V> using) Reads and returns the object from RandomCommon.readPosition() (i.
void	readMarshallable(net.openhft.chronicle.wire.WireIn wireIn)
void	write(net.openhft.chronicle.bytes.Bytes out, Map<K,V> toWrite) Serializes the given object to the given out.
void	writeMarshallable(net.openhft.chronicle.wire.WireOut wireOut)

Methods inherited from class java.lang.Object

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

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, reset, setField, setLongField, streamFromFile, streamFromFile

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

Methods inherited from interface net.openhft.chronicle.hash.serialization.StatefulCopyable

copyIfNeeded

Constructor Detail

MapMarshaller

public MapMarshaller(BytesReader<K> keyReader,
                     BytesWriter<? super K> keyWriter,
                     BytesReader<V> valueReader,
                     BytesWriter<? super V> valueWriter)

Constructs a MapMarshaller with the given map keys' and values' serializers.

Parameters:

keyReader - map keys' reader

keyWriter - map keys' writer

valueReader - map values' reader

valueWriter - map values' writer

Method Detail

read

@NotNull
public Map<K,V> read(net.openhft.chronicle.bytes.Bytes in,
                              @Nullable
                              Map<K,V> using)

Description copied from interface: BytesReader

Reads and returns the object from RandomCommon.readPosition() (i. e. the current position) in the given in. Should attempt to reuse the given using object, i. e. to read the deserialized data into the given object. If it is possible, this object then returned from this method back. If it is impossible for any reason, a new object should be created and returned. The given using object could be null, in this case this method, of cause, should create a new object.

This method should increment the position in the given Bytes, i. e. consume the read bytes. in bytes shouldn't be written.

Specified by:

read in interface BytesReader<Map<K,V>>

Parameters:

in - the Bytes to read the object from

using - the object to read the deserialized data into, could be null

Returns:

the object read from the bytes, either reused or newly created

write

public void write(net.openhft.chronicle.bytes.Bytes out,
                  @NotNull
                  Map<K,V> toWrite)

Description copied from interface: BytesWriter

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.

Specified by:

write in interface BytesWriter<Map<K,V>>

Parameters:

out - the Bytes to write the given object to

toWrite - the object to serialize

copy

public MapMarshaller<K,V> copy()

Description copied from interface: StatefulCopyable

Creates a copy of this marshaller, with independent state. The current state itself shouldn't be copied (it could be "clear" in the copy), only "configuration" of the instance, on which copy() is called, should be inherited in the copy (e. g. the class of objects serialized). So, copy() should be transitive, i. e. marshaller.copy() and marshaller.copy().copy() should result to identical instances.

The state of the instance on which copy() is called shouldn't be changed.

If some marshaller is ought to implement StatefulCopyable interface (e. g. DataAccess) but is stateless actually, it could return this from this method.

Specified by:

copy in interface StatefulCopyable<MapMarshaller<K,V>>

Returns:

the copy if this marshaller with the same configuration, but independent state

readMarshallable

public void readMarshallable(@NotNull
                             net.openhft.chronicle.wire.WireIn wireIn)

Specified by:

readMarshallable in interface net.openhft.chronicle.wire.Marshallable

Specified by:

readMarshallable in interface net.openhft.chronicle.wire.ReadMarshallable

writeMarshallable

public void writeMarshallable(@NotNull
                              net.openhft.chronicle.wire.WireOut wireOut)

Specified by:

writeMarshallable in interface net.openhft.chronicle.wire.Marshallable

Specified by:

writeMarshallable in interface net.openhft.chronicle.wire.WriteMarshallable