Class CompatibleFieldSerializer<T>
- java.lang.Object
-
- com.esotericsoftware.kryo.Serializer<T>
-
- com.esotericsoftware.kryo.serializers.FieldSerializer<T,FieldSerializerConfig>
-
- com.esotericsoftware.kryo.serializers.CompatibleFieldSerializer<T>
-
- All Implemented Interfaces:
Comparator<FieldSerializer.CachedField>
public class CompatibleFieldSerializer<T> extends FieldSerializer<T,FieldSerializerConfig>
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. Changing the type of a field is not supported. LikeFieldSerializer
, it can serialize most classes without needing annotations. The forward and backward compatibility comes at a cost: the first time the class is encountered in the serialized bytes, a simple schema is written containing the field name strings. Also, during serialization and deserialization buffers are allocated to perform chunked encoding. This is what enables CompatibleFieldSerializer to skip bytes for fields it does not know about.Removing fields when
references
are enabled can cause compatibility issues. See here.Note that the field data is identified by name. The situation where a super class has a field with the same name as a subclass must be avoided.
- Author:
- Nathan Sweet
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.esotericsoftware.kryo.serializers.FieldSerializer
FieldSerializer.Bind, FieldSerializer.CachedField<X>, FieldSerializer.CachedFieldFactory, FieldSerializer.CachedFieldNameStrategy, FieldSerializer.Optional
-
-
Field Summary
-
Fields inherited from class com.esotericsoftware.kryo.serializers.FieldSerializer
config, removedFields
-
-
Constructor Summary
Constructors Constructor Description CompatibleFieldSerializer(Kryo kryo, Class type)
CompatibleFieldSerializer(Kryo kryo, Class type, FieldSerializerConfig config)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description T
read(Kryo kryo, Input input, Class<T> type)
Reads bytes and returns a new object of the specified concrete type.void
write(Kryo kryo, Output output, T object)
This method can be called for different fields having the same type.-
Methods inherited from class com.esotericsoftware.kryo.serializers.FieldSerializer
compare, copy, create, createCopy, getCachedFieldName, getConfig, getCopyTransient, getField, getFields, getGenerics, getKryo, getSerializeTransient, getTransientFields, getType, initializeCachedFields, rebuildCachedFields, rebuildCachedFields, removeField, removeField, setCopyTransient, setFieldsAsAccessible, setFieldsCanBeNull, setFixedFieldTypes, setGenerics, setIgnoreSyntheticFields, setOptimizedGenerics, setSerializeTransient
-
Methods inherited from class com.esotericsoftware.kryo.Serializer
getAcceptsNull, isImmutable, setAcceptsNull, setImmutable
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.util.Comparator
equals, reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong
-
-
-
-
Constructor Detail
-
CompatibleFieldSerializer
public CompatibleFieldSerializer(Kryo kryo, Class type, FieldSerializerConfig config)
-
-
Method Detail
-
write
public void write(Kryo kryo, Output output, T object)
Description copied from class:FieldSerializer
This method can be called for different fields having the same type. Even though the raw type is the same, if the type is generic, it could happen that different concrete classes are used to instantiate it. Therefore, in case of different instantiation parameters, the fields analysis should be repeated. TODO: Cache serializer instances generated for a given set of generic parameters. Reuse it later instead of recomputing every time.- Overrides:
write
in classFieldSerializer<T,FieldSerializerConfig>
object
- May be null ifSerializer.getAcceptsNull()
is true.
-
read
public T read(Kryo kryo, Input input, Class<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,FieldSerializerConfig>
- Returns:
- May be null if
Serializer.getAcceptsNull()
is true.
-
-