Class CompatibleFieldSerializer<T>
- java.lang.Object
-
- com.esotericsoftware.kryo.Serializer<T>
-
- com.esotericsoftware.kryo.serializers.FieldSerializer<T>
-
- com.esotericsoftware.kryo.serializers.CompatibleFieldSerializer<T>
-
public class CompatibleFieldSerializer<T> extends FieldSerializer<T>
Serializes objects using direct field assignment, providing both forward and backward compatibility. This means fields can be added or removed without invalidating previously serialized bytes. Renaming or changing the type of a field is not supported. LikeFieldSerializer
, it can serialize most classes without needing annotations.The forward and backward compatibility and serialization performance depend on
CompatibleFieldSerializer.CompatibleFieldSerializerConfig.setReadUnknownFieldData(boolean)
andCompatibleFieldSerializer.CompatibleFieldSerializerConfig.setChunkedEncoding(boolean)
. Additionally, the first time the class is encountered in the serialized bytes, a simple schema is written containing the field name strings.Note that the field data is identified by name. If a super class has a field with the same name as a subclass,
FieldSerializer.FieldSerializerConfig.setExtendedFieldNames(boolean)
must be true.- Author:
- Nathan Sweet
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CompatibleFieldSerializer.CompatibleFieldSerializerConfig
Configuration for CompatibleFieldSerializer instances.-
Nested classes/interfaces inherited from class com.esotericsoftware.kryo.serializers.FieldSerializer
FieldSerializer.Bind, FieldSerializer.CachedField, FieldSerializer.FieldSerializerConfig, FieldSerializer.NotNull, FieldSerializer.Optional
-
-
Constructor Summary
Constructors Constructor Description CompatibleFieldSerializer(Kryo kryo, java.lang.Class type)
CompatibleFieldSerializer(Kryo kryo, java.lang.Class type, CompatibleFieldSerializer.CompatibleFieldSerializerConfig config)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CompatibleFieldSerializer.CompatibleFieldSerializerConfig
getCompatibleFieldSerializerConfig()
T
read(Kryo kryo, Input input, java.lang.Class<? extends T> type)
Reads bytes and returns a new object of the specified concrete type.void
write(Kryo kryo, Output output, T object)
Writes the bytes for the object to the output.-
Methods inherited from class com.esotericsoftware.kryo.serializers.FieldSerializer
copy, create, createCopy, getCopyFields, getField, getFields, getFieldSerializerConfig, getKryo, getType, initializeCachedFields, log, popTypeVariables, pushTypeVariables, removeField, removeField, updateFields
-
Methods inherited from class com.esotericsoftware.kryo.Serializer
getAcceptsNull, isImmutable, setAcceptsNull, setImmutable
-
-
-
-
Constructor Detail
-
CompatibleFieldSerializer
public CompatibleFieldSerializer(Kryo kryo, java.lang.Class type)
-
CompatibleFieldSerializer
public CompatibleFieldSerializer(Kryo kryo, java.lang.Class type, CompatibleFieldSerializer.CompatibleFieldSerializerConfig config)
-
-
Method Detail
-
write
public void write(Kryo kryo, Output output, T object)
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.- Overrides:
write
in classFieldSerializer<T>
object
- May be null ifSerializer.getAcceptsNull()
is true.
-
read
public T read(Kryo kryo, Input input, java.lang.Class<? extends T> 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.- Overrides:
read
in classFieldSerializer<T>
- Returns:
- May be null if
Serializer.getAcceptsNull()
is true.
-
getCompatibleFieldSerializerConfig
public CompatibleFieldSerializer.CompatibleFieldSerializerConfig getCompatibleFieldSerializerConfig()
-
-