Class CollectionSerializer
- java.lang.Object
-
- com.esotericsoftware.kryo.Serializer<java.util.Collection>
-
- com.esotericsoftware.kryo.serializers.CollectionSerializer
-
public class CollectionSerializer extends Serializer<java.util.Collection>
Serializes objects that implement theCollection
interface.With the default constructor, a collection requires a 1-3 byte header and an extra 2-3 bytes is written for each element in the collection. The alternate constructor can be used to improve efficiency to match that of using an array instead of a collection.
-
-
Constructor Summary
Constructors Constructor Description CollectionSerializer()
CollectionSerializer(java.lang.Class elementClass, Serializer serializer)
CollectionSerializer(java.lang.Class elementClass, Serializer serializer, boolean elementsCanBeNull)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Collection
copy(Kryo kryo, java.util.Collection original)
Returns a copy of the specified object.protected java.util.Collection
create(Kryo kryo, Input input, java.lang.Class<java.util.Collection> type)
Used byread(Kryo, Input, Class)
to create the new object.protected java.util.Collection
createCopy(Kryo kryo, java.util.Collection original)
Used bycopy(Kryo, Collection)
to create the new object.java.util.Collection
read(Kryo kryo, Input input, java.lang.Class<java.util.Collection> type)
Reads bytes and returns a new object of the specified concrete type.void
setElementClass(java.lang.Class elementClass, Serializer serializer)
void
setElementsCanBeNull(boolean elementsCanBeNull)
void
setGenerics(Kryo kryo, java.lang.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
write(Kryo kryo, Output output, java.util.Collection collection)
Writes the bytes for the object to the output.-
Methods inherited from class com.esotericsoftware.kryo.Serializer
getAcceptsNull, isImmutable, setAcceptsNull, setImmutable
-
-
-
-
Constructor Detail
-
CollectionSerializer
public CollectionSerializer()
-
CollectionSerializer
public CollectionSerializer(java.lang.Class elementClass, Serializer serializer)
- See Also:
setElementClass(Class, Serializer)
-
CollectionSerializer
public CollectionSerializer(java.lang.Class elementClass, Serializer serializer, boolean elementsCanBeNull)
-
-
Method Detail
-
setElementsCanBeNull
public void setElementsCanBeNull(boolean elementsCanBeNull)
- Parameters:
elementsCanBeNull
- False if all elements are not null. This saves 1 byte per element if elementClass is set. True if it is not known (default).
-
setElementClass
public void setElementClass(java.lang.Class elementClass, Serializer serializer)
- Parameters:
elementClass
- The concrete class of each element. This saves 1-2 bytes per element. Set to null if the class is not known or varies per element (default).serializer
- The serializer to use for each element.
-
setGenerics
public void setGenerics(Kryo kryo, java.lang.Class[] generics)
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<java.util.Collection>
generics
- Some (but never all) elements may be null if there is no generic type information at that index.
-
write
public void write(Kryo kryo, Output output, java.util.Collection collection)
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<java.util.Collection>
collection
- May be null ifSerializer.getAcceptsNull()
is true.
-
create
protected java.util.Collection create(Kryo kryo, Input input, java.lang.Class<java.util.Collection> type)
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
public java.util.Collection read(Kryo kryo, Input input, java.lang.Class<java.util.Collection> type)
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<java.util.Collection>
- Returns:
- May be null if
Serializer.getAcceptsNull()
is true.
-
createCopy
protected java.util.Collection createCopy(Kryo kryo, java.util.Collection original)
Used bycopy(Kryo, Collection)
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)
.
-
copy
public java.util.Collection copy(Kryo kryo, java.util.Collection original)
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<java.util.Collection>
-
-