Module dev.metaschema.databind

Package dev.metaschema.databind.io

Class AbstractSerializer<CLASS extends IBoundObject>

java.lang.Object

dev.metaschema.databind.io.AbstractSerializer<CLASS>

Type Parameters:

CLASS - the bound class to serialize from

All Implemented Interfaces:

IConfiguration<SerializationFeature<?>>, IMutableConfiguration<SerializationFeature<?>>, ISerializer<CLASS>

Direct Known Subclasses:

DefaultJsonSerializer, DefaultXmlSerializer

public abstract class AbstractSerializer<CLASS extends IBoundObject>
extends Object
implements ISerializer<CLASS>

The base class of all format-specific serializers.

Constructor Summary

Constructors

Constructor	Description
AbstractSerializer(IBoundDefinitionModelAssembly definition)	Construct a new serializer.

Method Summary

Modifier and Type	Method	Description
ISerializer<CLASS>	applyConfiguration(IConfiguration<SerializationFeature<?>> other)	Replace this configuration with the other configuration.
protected void	configurationChanged(IMutableConfiguration<SerializationFeature<?>> config)	Callback method invoked when the configuration has been changed.
ISerializer<CLASS>	disableFeature(SerializationFeature<?> feature)	Turn off the provided feature.
ISerializer<CLASS>	enableFeature(SerializationFeature<?> feature)	Turn on the provided feature.
<V> V	get(SerializationFeature<?> feature)	Get the configuration value of the provided feature.
protected IBindingContext	getBindingContext()	Retrieve the binding context associated with the serializer.
protected IMutableConfiguration<SerializationFeature<?>>	getConfiguration()	Get the current configuration of the serializer/deserializer.
protected IBoundDefinitionModelAssembly	getDefinition()	Retrieve the bound class information associated with the assembly that the serializer/deserializer will write/read data from.
Map<SerializationFeature<?>,Object>	getFeatureValues()	Get the mapping of each feature mapped to its value.
boolean	isFeatureEnabled(SerializationFeature<?> feature)	Determines if a specific feature is enabled.
ISerializer<CLASS>	set(SerializationFeature<?> feature, Object value)	Set the value of the provided feature to the provided value.

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.metaschema.core.configuration.IConfiguration

get, getFeatureValues, isFeatureEnabled

Methods inherited from interface dev.metaschema.databind.io.ISerializer

serialize, serialize, serialize, serialize

Constructor Details

AbstractSerializer

public AbstractSerializer(@NonNull
 IBoundDefinitionModelAssembly definition)

Construct a new serializer.

Parameters:

definition - the bound class information for the Java type this serializer is operating on

Method Details

enableFeature

public ISerializer<CLASS> enableFeature(SerializationFeature<?> feature)

Description copied from interface: IMutableConfiguration

Turn on the provided feature.

Specified by:

enableFeature in interface IMutableConfiguration<CLASS extends IBoundObject>

Specified by:

enableFeature in interface ISerializer<CLASS extends IBoundObject>

Parameters:

feature - the feature to turn on

Returns:

the updated configuration

See Also:

• IConfigurationFeature.getValueClass()

disableFeature

public ISerializer<CLASS> disableFeature(SerializationFeature<?> feature)

Description copied from interface: IMutableConfiguration

Turn off the provided feature.

Specified by:

disableFeature in interface IMutableConfiguration<CLASS extends IBoundObject>

Specified by:

disableFeature in interface ISerializer<CLASS extends IBoundObject>

Parameters:

feature - the feature to turn off

Returns:

the updated configuration

See Also:

• IConfigurationFeature.getValueClass()

applyConfiguration

public ISerializer<CLASS> applyConfiguration(@NonNull
 IConfiguration<SerializationFeature<?>> other)

Description copied from interface: IMutableConfiguration

Replace this configuration with the other configuration.

Specified by:

applyConfiguration in interface IMutableConfiguration<CLASS extends IBoundObject>

Specified by:

applyConfiguration in interface ISerializer<CLASS extends IBoundObject>

Parameters:

other - the new configuration

Returns:

the updated configuration

set

public ISerializer<CLASS> set(SerializationFeature<?> feature,
 Object value)

Description copied from interface: IMutableConfiguration

Set the value of the provided feature to the provided value.

Specified by:

set in interface IMutableConfiguration<CLASS extends IBoundObject>

Specified by:

set in interface ISerializer<CLASS extends IBoundObject>

Parameters:

feature - the feature to set

value - the value to set

Returns:

the updated configuration

See Also:

• IConfigurationFeature.getValueClass()

getBindingContext

@NonNull
protected IBindingContext getBindingContext()

Retrieve the binding context associated with the serializer.

Returns:

the binding context

getDefinition

@NonNull
protected IBoundDefinitionModelAssembly getDefinition()

Retrieve the bound class information associated with the assembly that the serializer/deserializer will write/read data from.

Returns:

the class binding for the Module assembly

configurationChanged

protected void configurationChanged(@NonNull
 IMutableConfiguration<SerializationFeature<?>> config)

Callback method invoked when the configuration has been changed.

Subclasses can override this method to handle configuration changes, such as resetting cached factory instances.

Parameters:

config - the updated configuration

getConfiguration

@NonNull
protected IMutableConfiguration<SerializationFeature<?>> getConfiguration()

Get the current configuration of the serializer/deserializer.

Returns:

the configuration

isFeatureEnabled

public boolean isFeatureEnabled(SerializationFeature<?> feature)

Description copied from interface: IConfiguration

Determines if a specific feature is enabled.

Specified by:

isFeatureEnabled in interface IConfiguration<T extends IConfigurationFeature<?>>

Parameters:

feature - the feature to check for

Returns:

true if the feature is enabled, or false otherwise

See Also:

• IConfigurationFeature.getValueClass()

getFeatureValues

public Map<SerializationFeature<?>,Object> getFeatureValues()

Description copied from interface: IConfiguration

Get the mapping of each feature mapped to its value.

Specified by:

getFeatureValues in interface IConfiguration<T extends IConfigurationFeature<?>>

Returns:

the mapping

get

public <V> V get(SerializationFeature<?> feature)

Description copied from interface: IConfiguration

Get the configuration value of the provided feature.

Specified by:

get in interface IConfiguration<T extends IConfigurationFeature<?>>

Type Parameters:

V - the value type

Parameters:

feature - the requested feature

Returns:

the value of the feature