public class TaggedFieldSerializer<T> extends FieldSerializer<T>
@Tag(int)
annotation. This provides
backward compatibility so new fields can be added. TaggedFieldSerializer has two advantages over VersionFieldSerializer
: 1) fields can be renamed and 2) fields marked with the @Deprecated
annotation will be ignored when reading old
bytes and won't be written to new bytes. Deprecation effectively removes the field from serialization, though the field and
@Tag
annotation must remain in the class. Deprecated fields can optionally be made private and/or renamed so they
don't clutter the class (eg, ignored
, ignored2
). For these reasons, TaggedFieldSerializer generally
provides more flexibility for classes to evolve. The downside is that it has a small amount of additional overhead compared to
VersionFieldSerializer (an additional varint per field). Forward compatibility is not supported.VersionFieldSerializer
Modifier and Type | Class and Description |
---|---|
static interface |
TaggedFieldSerializer.Tag
If true, this field will not be serialized.
|
FieldSerializer.Bind, FieldSerializer.CachedField<X>, FieldSerializer.CachedFieldFactory, FieldSerializer.Optional
removedFields
Constructor and Description |
---|
TaggedFieldSerializer(Kryo kryo,
Class type) |
Modifier and Type | Method and Description |
---|---|
protected void |
initializeCachedFields() |
T |
read(Kryo kryo,
Input input,
Class<T> type)
Reads bytes and returns a new object of the specified concrete type.
|
void |
removeField(FieldSerializer.CachedField field)
Removes a field so that it won't be serialized.
|
void |
removeField(String fieldName)
Removes a field so that it won't be serialized.
|
void |
write(Kryo kryo,
Output output,
T object)
This method can be called for different fields having the same type.
|
compare, copy, create, createCopy, getCopyTransient, getField, getFields, getGenerics, getGenericsScope, getKryo, getType, getUseAsmEnabled, getUseMemRegions, rebuildCachedFields, rebuildCachedFields, setCopyTransient, setFieldsAsAccessible, setFieldsCanBeNull, setFixedFieldTypes, setGenerics, setIgnoreSyntheticFields, setUseAsm
getAcceptsNull, isImmutable, setAcceptsNull, setImmutable
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong
protected void initializeCachedFields()
initializeCachedFields
in class FieldSerializer<T>
public void removeField(String fieldName)
FieldSerializer
removeField
in class FieldSerializer<T>
public void removeField(FieldSerializer.CachedField field)
FieldSerializer
removeField
in class FieldSerializer<T>
public void write(Kryo kryo, Output output, T object)
FieldSerializer
write
in class FieldSerializer<T>
object
- May be null if Serializer.getAcceptsNull()
is true.public T read(Kryo kryo, Input input, Class<T> type)
Serializer
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 uses Kryo
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.
read
in class FieldSerializer<T>
Serializer.getAcceptsNull()
is true.Copyright © 2018. All rights reserved.