Module gov.nist.secauto.metaschema.databind

Package gov.nist.secauto.metaschema.databind.io

Class AbstractDeserializer<CLASS extends IBoundObject>

java.lang.Object

gov.nist.secauto.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)
protected void	configurationChanged(IMutableConfiguration<DeserializationFeature<?>> config)
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)
IDeserializer<CLASS>	disableFeature(DeserializationFeature<?> feature)
IDeserializer<CLASS>	enableFeature(DeserializationFeature<?> feature)
<V> V	get(DeserializationFeature<?> 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()
boolean	isFeatureEnabled(DeserializationFeature<?> feature)
IDeserializer<CLASS>	set(DeserializationFeature<?> feature, Object 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 gov.nist.secauto.metaschema.core.configuration.IConfiguration

get, getFeatureValues, isFeatureEnabled

Methods inherited from interface gov.nist.secauto.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

Throws:

IOException

enableFeature

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

Specified by:

enableFeature in interface IDeserializer<CLASS extends IBoundObject>

Specified by:

enableFeature in interface IMutableConfiguration<CLASS extends IBoundObject>

disableFeature

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

Specified by:

disableFeature in interface IDeserializer<CLASS extends IBoundObject>

Specified by:

disableFeature in interface IMutableConfiguration<CLASS extends IBoundObject>

applyConfiguration

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

Specified by:

applyConfiguration in interface IDeserializer<CLASS extends IBoundObject>

Specified by:

applyConfiguration in interface IMutableConfiguration<CLASS extends IBoundObject>

set

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

Specified by:

set in interface IDeserializer<CLASS extends IBoundObject>

Specified by:

set in interface IMutableConfiguration<CLASS extends IBoundObject>

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)

getConfiguration

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

Get the current configuration of the serializer/deserializer.

Returns:

the configuration

isFeatureEnabled

public boolean isFeatureEnabled(DeserializationFeature<?> feature)

Specified by:

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

getFeatureValues

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

Specified by:

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

get

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

Specified by:

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