Module dev.metaschema.databind

Package dev.metaschema.databind.io

Class AbstractDeserializer<CLASS extends IBoundObject>

java.lang.Object

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

Type Parameters:

CLASS - the bound class to deserialize to

All Implemented Interfaces:

IConfiguration<DeserializationFeature<?>>, IMutableConfiguration<DeserializationFeature<?>>, IDeserializer<CLASS>

Direct Known Subclasses:

DefaultJsonDeserializer, DefaultXmlDeserializer

public abstract class AbstractDeserializer<CLASS extends IBoundObject>
extends Object
implements IDeserializer<CLASS>

The base class of all format-specific deserializers.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractDeserializer(IBoundDefinitionModelAssembly definition)	Construct a new deserializer.

Method Summary

Modifier and Type	Method	Description
IDeserializer<CLASS>	applyConfiguration(IConfiguration<DeserializationFeature<?>> other)	Replace this configuration with the other configuration.
protected void	configurationChanged(IMutableConfiguration<DeserializationFeature<?>> config)	Callback method invoked when the configuration has been changed.
INodeItem	deserializeToNodeItem(Reader reader, URI documentUri)	Read data from the Reader into a node item instance.
protected abstract INodeItem	deserializeToNodeItemInternal(Reader reader, URI documentUri)	This abstract method delegates parsing to the concrete implementation.
final CLASS	deserializeToValue(Reader reader, URI documentUri)	Read data from the Reader into a node item instance.
protected abstract CLASS	deserializeToValueInternal(Reader reader, URI documentUri)	This abstract method delegates parsing to the concrete implementation, returning the deserialized value directly.
IDeserializer<CLASS>	disableFeature(DeserializationFeature<?> feature)	Turn off the provided feature.
IDeserializer<CLASS>	enableFeature(DeserializationFeature<?> feature)	Turn on the provided feature.
<V> V	get(DeserializationFeature<?> feature)	Get the configuration value of the provided feature.
protected IBindingContext	getBindingContext()	Retrieve the binding context associated with the serializer.
protected IMutableConfiguration<DeserializationFeature<?>>	getConfiguration()	Get the current configuration of the serializer/deserializer.
IConstraintValidationHandler	getConstraintValidationHandler()	Get the constraint validation handler configured for this deserializer, which will be used to validate loaded data.
protected IBoundDefinitionModelAssembly	getDefinition()	Retrieve the bound class information associated with the assembly that the serializer/deserializer will write/read data from.
Map<DeserializationFeature<?>,Object>	getFeatureValues()	Get the mapping of each feature mapped to its value.
boolean	isFeatureEnabled(DeserializationFeature<?> feature)	Determines if a specific feature is enabled.
IDeserializer<CLASS>	set(DeserializationFeature<?> feature, Object value)	Set the value of the provided feature to the provided value.
void	setConstraintValidationHandler(IConstraintValidationHandler constraintValidationHandler)	Set the constraint violation handler for constraint validation.

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.IDeserializer

deserialize, deserialize, deserialize, deserialize, deserialize, deserializeToNodeItem, isValidating

Constructor Details

AbstractDeserializer

protected AbstractDeserializer(@NonNull
 IBoundDefinitionModelAssembly definition)

Construct a new deserializer.

Parameters:

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

Method Details

getConstraintValidationHandler

@NonNull
public IConstraintValidationHandler getConstraintValidationHandler()

Get the constraint validation handler configured for this deserializer, which will be used to validate loaded data.

Specified by:

getConstraintValidationHandler in interface IDeserializer<CLASS extends IBoundObject>

Returns:

the deserializer

setConstraintValidationHandler

public void setConstraintValidationHandler(@NonNull
 IConstraintValidationHandler constraintValidationHandler)

Description copied from interface: IDeserializer

Set the constraint violation handler for constraint validation.

Specified by:

setConstraintValidationHandler in interface IDeserializer<CLASS extends IBoundObject>

Parameters:

constraintValidationHandler - the handler to use

deserializeToNodeItem

public INodeItem deserializeToNodeItem(Reader reader,
 URI documentUri)
                                throws IOException

Description copied from interface: IDeserializer

Read data from the Reader into a node item instance.

Specified by:

deserializeToNodeItem in interface IDeserializer<CLASS extends IBoundObject>

Parameters:

reader - the reader to read from

documentUri - the URI of the document to read from

Returns:

a new node item

Throws:

IOException - if an error occurred while reading data from the stream

deserializeToNodeItemInternal

@NonNull
protected abstract INodeItem deserializeToNodeItemInternal(@NonNull
 Reader reader,
 @NonNull
 URI documentUri)
                                                    throws IOException

This abstract method delegates parsing to the concrete implementation.

Parameters:

reader - the reader instance to read data from

documentUri - the URI of the document that is being read

Returns:

a new node item containing the read contents

Throws:

IOException - if an error occurred while reading data from the stream

deserializeToValue

public final CLASS deserializeToValue(Reader reader,
 URI documentUri)
                               throws IOException

Description copied from interface: IDeserializer

Read data from the Reader into a node item instance.

Specified by:

deserializeToValue in interface IDeserializer<CLASS extends IBoundObject>

Parameters:

reader - the reader to read from

documentUri - the URI of the document to read from

Returns:

a new node item

Throws:

IOException - if an error occurred while reading data from the stream

deserializeToValueInternal

@NonNull
protected abstract CLASS deserializeToValueInternal(@NonNull
 Reader reader,
 @NonNull
 URI documentUri)
                                             throws IOException

This abstract method delegates parsing to the concrete implementation, returning the deserialized value directly.

Parameters:

reader - the reader instance to read data from

documentUri - the URI of the document that is being read

Returns:

the deserialized object

Throws:

IOException - if an error occurred while reading data from the stream

enableFeature

public IDeserializer<CLASS> enableFeature(DeserializationFeature<?> feature)

Description copied from interface: IMutableConfiguration

Turn on the provided feature.

Specified by:

enableFeature in interface IDeserializer<CLASS extends IBoundObject>

Specified by:

enableFeature in interface IMutableConfiguration<CLASS extends IBoundObject>

Parameters:

feature - the feature to turn on

Returns:

the updated configuration

See Also:

• IConfigurationFeature.getValueClass()

disableFeature

public IDeserializer<CLASS> disableFeature(DeserializationFeature<?> feature)

Description copied from interface: IMutableConfiguration

Turn off the provided feature.

Specified by:

disableFeature in interface IDeserializer<CLASS extends IBoundObject>

Specified by:

disableFeature in interface IMutableConfiguration<CLASS extends IBoundObject>

Parameters:

feature - the feature to turn off

Returns:

the updated configuration

See Also:

• IConfigurationFeature.getValueClass()

applyConfiguration

public IDeserializer<CLASS> applyConfiguration(@NonNull
 IConfiguration<DeserializationFeature<?>> other)

Description copied from interface: IMutableConfiguration

Replace this configuration with the other configuration.

Specified by:

applyConfiguration in interface IDeserializer<CLASS extends IBoundObject>

Specified by:

applyConfiguration in interface IMutableConfiguration<CLASS extends IBoundObject>

Parameters:

other - the new configuration

Returns:

the updated configuration

set

public IDeserializer<CLASS> set(DeserializationFeature<?> feature,
 Object value)

Description copied from interface: IMutableConfiguration

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

Specified by:

set in interface IDeserializer<CLASS extends IBoundObject>

Specified by:

set in interface IMutableConfiguration<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<DeserializationFeature<?>> 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<DeserializationFeature<?>> getConfiguration()

Get the current configuration of the serializer/deserializer.

Returns:

the configuration

isFeatureEnabled

public boolean isFeatureEnabled(DeserializationFeature<?> 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<DeserializationFeature<?>,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(DeserializationFeature<?> 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