com.esotericsoftware.kryo.serializers

Class FieldSerializerConfig

java.lang.Object

com.esotericsoftware.kryo.serializers.FieldSerializerConfig

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

TaggedFieldSerializerConfig

public class FieldSerializerConfig
extends Object
implements Cloneable

Configuration for FieldSerializer instances. To configure defaults for new FieldSerializer instances use Kryo.getFieldSerializerConfig(), to configure a specific FieldSerializer instance use setters for configuration settings on this specific FieldSerializer.

Constructor Summary

Constructors

Constructor and Description
FieldSerializerConfig()

Method Summary

Modifier and Type	Method and Description
protected FieldSerializerConfig	clone()
FieldSerializer.CachedFieldNameStrategy	getCachedFieldNameStrategy()
boolean	isCopyTransient()
boolean	isFieldsCanBeNull()
boolean	isFixedFieldTypes()
boolean	isIgnoreSyntheticFields()
boolean	isOptimizedGenerics()
boolean	isSerializeTransient()
boolean	isSetFieldsAsAccessible()
boolean	isUseAsm()
void	setCachedFieldNameStrategy(FieldSerializer.CachedFieldNameStrategy cachedFieldNameStrategy)
void	setCopyTransient(boolean setCopyTransient) If false, when Kryo.copy(Object) is called all transient fields that are accessible will be ignored from being copied.
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	setOptimizedGenerics(boolean setOptimizedGenerics) Controls if the serialization of generics should be optimized for smaller size.
void	setSerializeTransient(boolean serializeTransient) If set, transient fields will be serialized Default is false
void	setUseAsm(boolean setUseAsm) Controls whether ASM should be used.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FieldSerializerConfig

public FieldSerializerConfig()

Method Detail

clone

protected FieldSerializerConfig clone()

Overrides:

clone in class Object

setFieldsCanBeNull

public void setFieldsCanBeNull(boolean fieldsCanBeNull)

Sets the default value for FieldSerializer.CachedField.setCanBeNull(boolean).

Parameters:

fieldsCanBeNull - False if none of the fields are null. Saves 0-1 byte per field. True if it is not known (default).

setFieldsAsAccessible

public void setFieldsAsAccessible(boolean setFieldsAsAccessible)

Controls which fields are serialized.

Parameters:

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.

setIgnoreSyntheticFields

public void setIgnoreSyntheticFields(boolean ignoreSyntheticFields)

Controls if synthetic fields are serialized. Default is true.

Parameters:

ignoreSyntheticFields - If true, only non-synthetic fields will be serialized.

setFixedFieldTypes

public void setFixedFieldTypes(boolean fixedFieldTypes)

Sets the default value for 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.

setUseAsm

public void setUseAsm(boolean setUseAsm)

Controls whether ASM should be used.

Parameters:

setUseAsm - If true, ASM will be used for fast serialization. If false, Unsafe will be used (default)

setOptimizedGenerics

public void setOptimizedGenerics(boolean setOptimizedGenerics)

Controls if the serialization of generics should be optimized for smaller size.

Important: This setting changes the serialized representation, so that data can be deserialized only with if this setting is the same as it was for serialization.

Parameters:

setOptimizedGenerics - If true, the serialization of generics will be optimize for smaller size (default: false)

setCopyTransient

public void setCopyTransient(boolean setCopyTransient)

If false, when Kryo.copy(Object) is called all transient fields that are accessible will be ignored from being copied. This has to be set before registering classes with kryo for it to be used by all field serializers. If transient fields has to be copied for specific classes then use FieldSerializer.setCopyTransient(boolean). Default is true.

setSerializeTransient

public void setSerializeTransient(boolean serializeTransient)

If set, transient fields will be serialized Default is false

Parameters:

serializeTransient -

isFieldsCanBeNull

public boolean isFieldsCanBeNull()

isSetFieldsAsAccessible

public boolean isSetFieldsAsAccessible()

isIgnoreSyntheticFields

public boolean isIgnoreSyntheticFields()

isFixedFieldTypes

public boolean isFixedFieldTypes()

isUseAsm

public boolean isUseAsm()

isOptimizedGenerics

public boolean isOptimizedGenerics()

isCopyTransient

public boolean isCopyTransient()

isSerializeTransient

public boolean isSerializeTransient()

getCachedFieldNameStrategy

public FieldSerializer.CachedFieldNameStrategy getCachedFieldNameStrategy()

setCachedFieldNameStrategy

public void setCachedFieldNameStrategy(FieldSerializer.CachedFieldNameStrategy cachedFieldNameStrategy)