|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.esotericsoftware.kryo.Serializer<T>
com.esotericsoftware.kryo.serializers.FieldSerializer<T>
public class FieldSerializer<T>
Serializes objects using direct field assignment. No header or schema data is stored, only the data for each field. This reduces output size but means if any field is added or removed, previously serialized bytes are invalidated. If fields are public, bytecode generation will be used instead of reflection.
Serializer
,
Kryo.register(Class, Serializer)
Nested Class Summary | |
---|---|
class |
FieldSerializer.CachedField<X>
Controls how a field will be serialized. |
static interface |
FieldSerializer.Optional
Indicates a field should be ignored when its declaring class is registered unless the context has
a value set for the specified key. |
Constructor Summary | |
---|---|
FieldSerializer(Kryo kryo,
java.lang.Class type)
|
Method Summary | |
---|---|
int |
compare(FieldSerializer.CachedField o1,
FieldSerializer.CachedField o2)
|
T |
copy(Kryo kryo,
T original)
Returns a copy of the specified object. |
protected T |
create(Kryo kryo,
Input input,
java.lang.Class<T> type)
Used by read(Kryo, Input, Class) to create the new object. |
protected T |
createCopy(Kryo kryo,
T original)
Used by copy(Kryo, Object) to create the new object. |
FieldSerializer.CachedField |
getField(java.lang.String fieldName)
Allows specific fields to be optimized. |
FieldSerializer.CachedField[] |
getFields()
|
java.lang.Class |
getType()
|
protected void |
initializeCachedFields()
|
T |
read(Kryo kryo,
Input input,
java.lang.Class<T> type)
Reads bytes and returns a new object of the specified concrete type. |
void |
removeField(java.lang.String fieldName)
Removes a field so that it won't be serialized. |
void |
setFieldsAsAccessible(boolean setFieldsAsAccessible)
Controls which fields are serialized. |
void |
setFieldsCanBeNull(boolean fieldsCanBeNull)
Sets the default value for FieldSerializer.CachedField.setCanBeNull(boolean) . |
void |
setFixedFieldTypes(boolean fixedFieldTypes)
Sets the default value for FieldSerializer.CachedField.setClass(Class) to the field's declared type. |
void |
setIgnoreSyntheticFields(boolean ignoreSyntheticFields)
Controls if synthetic fields are serialized. |
void |
write(Kryo kryo,
Output output,
T object)
Writes the bytes for the object to the output. |
Methods inherited from class com.esotericsoftware.kryo.Serializer |
---|
getAcceptsNull, isImmutable, setAcceptsNull, setGenerics, 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 |
Constructor Detail |
---|
public FieldSerializer(Kryo kryo, java.lang.Class type)
Method Detail |
---|
protected void initializeCachedFields()
public int compare(FieldSerializer.CachedField o1, FieldSerializer.CachedField o2)
compare
in interface java.util.Comparator<FieldSerializer.CachedField>
public void setFieldsCanBeNull(boolean fieldsCanBeNull)
FieldSerializer.CachedField.setCanBeNull(boolean)
. Calling this method resets the cached fields
.
fieldsCanBeNull
- False if none of the fields are null. Saves 0-1 byte per field. True if it is not known (default).public void setFieldsAsAccessible(boolean setFieldsAsAccessible)
cached fields
.
setFieldsAsAccessible
- If true, all non-transient fields (inlcuding private fields) will be serialized and
set as accessible
if necessary (default). If false, only fields in the public
API will be serialized.public void setIgnoreSyntheticFields(boolean ignoreSyntheticFields)
cached
fields
.
ignoreSyntheticFields
- If true, only non-synthetic fields will be serialized.public void setFixedFieldTypes(boolean fixedFieldTypes)
FieldSerializer.CachedField.setClass(Class)
to the field's declared type. This allows FieldSerializer to
be more efficient, since it knows field values will not be a subclass of their declared type. Default is false. Calling this
method resets the cached fields
.
public void write(Kryo kryo, Output output, T object)
Serializer
This method should not be called directly, instead this serializer can be passed to Kryo
write methods that accept a
serialier.
write
in class Serializer<T>
object
- May be null if Serializer.getAcceptsNull()
is true.public T read(Kryo kryo, Input input, java.lang.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 Serializer<T>
Serializer.getAcceptsNull()
is true.protected T create(Kryo kryo, Input input, java.lang.Class<T> type)
read(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 uses Kryo.newInstance(Class)
.
public FieldSerializer.CachedField getField(java.lang.String fieldName)
public void removeField(java.lang.String fieldName)
public FieldSerializer.CachedField[] getFields()
public java.lang.Class getType()
protected T createCopy(Kryo kryo, T original)
copy(Kryo, Object)
to create the new object. This can be overridden to customize object creation, eg to
call a constructor with arguments. The default implementation uses Kryo.newInstance(Class)
.
public T copy(Kryo kryo, T original)
Serializer
Serializer.isImmutable()
is true,
else throws KryoException
. Subclasses should override this method if needed to support Kryo.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 uses Kryo
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.
copy
in class Serializer<T>
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |