Class MapSerializer
- Direct Known Subclasses:
DefaultSerializers.TreeMapSerializer
Map
interface.
With the default constructor, a map requires a 1-3 byte header and an extra 4 bytes is written for each key/value pair.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic @interface
Used to annotate fields that are maps with specific Kryo serializers for their keys or values. -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate Class
private Class
private boolean
private Serializer
private Class
private Class
private boolean
private Serializer
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns a copy of the specified object.protected Map
Used byread(Kryo, Input, Class)
to create the new object.protected Map
createCopy
(Kryo kryo, Map original) Reads bytes and returns a new object of the specified concrete type.void
setGenerics
(Kryo kryo, Class[] generics) Sets the generic types of the field or method this serializer will be used for on the next call to read or write.void
setKeyClass
(Class keyClass, Serializer keySerializer) void
setKeysCanBeNull
(boolean keysCanBeNull) void
setValueClass
(Class valueClass, Serializer valueSerializer) void
setValuesCanBeNull
(boolean valuesCanBeNull) void
Writes the bytes for the object to the output.Methods inherited from class com.esotericsoftware.kryo.Serializer
getAcceptsNull, isImmutable, setAcceptsNull, setImmutable
-
Field Details
-
keyClass
-
valueClass
-
keySerializer
-
valueSerializer
-
keysCanBeNull
private boolean keysCanBeNull -
valuesCanBeNull
private boolean valuesCanBeNull -
keyGenericType
-
valueGenericType
-
-
Constructor Details
-
MapSerializer
public MapSerializer()
-
-
Method Details
-
setKeysCanBeNull
public void setKeysCanBeNull(boolean keysCanBeNull) - Parameters:
keysCanBeNull
- False if all keys are not null. This saves 1 byte per key if keyClass is set. True if it is not known (default).
-
setKeyClass
- Parameters:
keyClass
- The concrete class of each key. This saves 1 byte per key. Set to null if the class is not known or varies per key (default).keySerializer
- The serializer to use for each key.
-
setValueClass
- Parameters:
valueClass
- The concrete class of each value. This saves 1 byte per value. Set to null if the class is not known or varies per value (default).valueSerializer
- The serializer to use for each value.
-
setValuesCanBeNull
public void setValuesCanBeNull(boolean valuesCanBeNull) - Parameters:
valuesCanBeNull
- True if values are not null. This saves 1 byte per value if keyClass is set. False if it is not known (default).
-
setGenerics
Description copied from class:Serializer
Sets the generic types of the field or method this serializer will be used for on the next call to read or write. Subsequent calls to read and write must not use this generic type information. The default implementation does nothing. Subclasses may use the information provided to this method for more efficient serialization, eg to use the same type for all items in a list.- Overrides:
setGenerics
in classSerializer<Map>
- Parameters:
generics
- Some (but never all) elements may be null if there is no generic type information at that index.
-
write
Description copied from class:Serializer
Writes the bytes for the object to the output.This method should not be called directly, instead this serializer can be passed to
Kryo
write methods that accept a serialier.- Specified by:
write
in classSerializer<Map>
- Parameters:
map
- May be null ifSerializer.getAcceptsNull()
is true.
-
create
Used byread(Kryo, Input, Class)
to create the new object. This can be overridden to customize object creation, eg to call a constructor with arguments. The default implementation usesKryo.newInstance(Class)
. -
read
Description copied from class:Serializer
Reads bytes and returns a new object of the specified concrete type.Before Kryo can be used to read child objects,
Kryo.reference(Object)
must be called with the parent object to ensure it can be referenced by the child objects. Any serializer that usesKryo
to read a child object may need to be reentrant.This method should not be called directly, instead this serializer can be passed to
Kryo
read methods that accept a serialier.- Specified by:
read
in classSerializer<Map>
- Returns:
- May be null if
Serializer.getAcceptsNull()
is true.
-
createCopy
-
copy
Description copied from class:Serializer
Returns a copy of the specified object. The default implementation returns the original ifSerializer.isImmutable()
is true, else throwsKryoException
. Subclasses should override this method if needed to supportKryo.copy(Object)
.Before Kryo can be used to copy child objects,
Kryo.reference(Object)
must be called with the copy to ensure it can be referenced by the child objects. Any serializer that usesKryo
to copy a child object may need to be reentrant.This method should not be called directly, instead this serializer can be passed to
Kryo
copy methods that accept a serialier.- Overrides:
copy
in classSerializer<Map>
-