Module gov.nist.secauto.metaschema.databind

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

Interface IDeserializer<CLASS>

Type Parameters:

CLASS - the Java type into which data can be read

All Superinterfaces:

IConfiguration<DeserializationFeature<?>>, IMutableConfiguration<DeserializationFeature<?>>

All Known Implementing Classes:

AbstractDeserializer, DefaultJsonDeserializer, DefaultXmlDeserializer, DefaultYamlDeserializer

public interface IDeserializer<CLASS>
extends IMutableConfiguration<DeserializationFeature<?>>

Implementations of this interface are able to read structured data into a bound object instance of the parameterized type.

Method Summary

Modifier and Type	Method	Description
IDeserializer<CLASS>	applyConfiguration(IConfiguration<DeserializationFeature<?>> other)
default CLASS	deserialize(File file)	Read data from the File into a bound class instance.
default CLASS	deserialize(InputStream is, URI documentUri)	Read data from the InputStream into a bound class instance.
default CLASS	deserialize(Reader reader, URI documentUri)	Read data from the Reader into a bound class instance.
default CLASS	deserialize(URL url)	Read data from the remote resource into a bound class instance.
default CLASS	deserialize(Path path)	Read data from the Path into a bound class instance.
default INodeItem	deserializeToNodeItem(InputStream is, URI documentUri)	Read data from the Reader into a node item instance.
INodeItem	deserializeToNodeItem(Reader reader, URI documentUri)	Read data from the Reader into a node item instance.
CLASS	deserializeToValue(Reader reader, URI documentUri)	Read data from the Reader into a node item instance.
IDeserializer<CLASS>	disableFeature(DeserializationFeature<?> feature)
IDeserializer<CLASS>	enableFeature(DeserializationFeature<?> feature)
IConstraintValidationHandler	getConstraintValidationHandler()	Get the constraint validation handler configured for this deserializer, which will be used to validate loaded data.
default boolean	isValidating()	Determine if the serializer is performing validation.
IDeserializer<CLASS>	set(DeserializationFeature<?> feature, Object value)
void	setConstraintValidationHandler(IConstraintValidationHandler handler)	Set the constraint violation handler for constraint validation.

Methods inherited from interface gov.nist.secauto.metaschema.core.configuration.IConfiguration

get, getFeatureValues, isFeatureEnabled

Method Detail

enableFeature

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

Specified by:

enableFeature in interface IMutableConfiguration<CLASS>

disableFeature

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

Specified by:

disableFeature in interface IMutableConfiguration<CLASS>

applyConfiguration

IDeserializer<CLASS> applyConfiguration(IConfiguration<DeserializationFeature<?>> other)

Specified by:

applyConfiguration in interface IMutableConfiguration<CLASS>

set

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

Specified by:

set in interface IMutableConfiguration<CLASS>

isValidating

default boolean isValidating()

Determine if the serializer is performing validation.

Returns:

true if the serializer is performing content validation, or false otherwise

getConstraintValidationHandler

@NonNull
IConstraintValidationHandler getConstraintValidationHandler()

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

Returns:

the validation handler

setConstraintValidationHandler

void setConstraintValidationHandler(@NonNull
                                    IConstraintValidationHandler handler)

Set the constraint violation handler for constraint validation.

Parameters:

handler - the handler to use

deserialize

@NonNull
default CLASS deserialize(@NonNull
                          InputStream is,
                          @NonNull
                          URI documentUri)
                   throws IOException

Read data from the InputStream into a bound class instance.

Parameters:

is - the input stream to read from

documentUri - the URI of the document to read from

Returns:

the instance data

Throws:

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

deserialize

@NonNull
default CLASS deserialize(@NonNull
                          Path path)
                   throws IOException

Read data from the Path into a bound class instance.

Parameters:

path - the file to read from

Returns:

the instance data

Throws:

IOException - if an error occurred while writing data to the file indicated by the path parameter

deserialize

@NonNull
default CLASS deserialize(@NonNull
                          File file)
                   throws IOException

Read data from the File into a bound class instance.

Parameters:

file - the file to read from

Returns:

the instance data

Throws:

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

deserialize

@NonNull
default CLASS deserialize(@NonNull
                          URL url)
                   throws IOException,
                          URISyntaxException

Read data from the remote resource into a bound class instance.

Parameters:

url - the remote resource to read from

Returns:

the instance data

Throws:

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

URISyntaxException - if the provided URL is not formatted strictly according to to RFC2396 and cannot be converted to a URI.

deserialize

@NonNull
default CLASS deserialize(@NonNull
                          Reader reader,
                          @NonNull
                          URI documentUri)
                   throws IOException

Read data from the Reader into a bound class instance.

Parameters:

reader - the reader to read from

documentUri - the URI of the document to read from

Returns:

the instance data

Throws:

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

deserializeToNodeItem

@NonNull
default INodeItem deserializeToNodeItem(@NonNull
                                        InputStream is,
                                        @NonNull
                                        URI documentUri)
                                 throws IOException

Read data from the Reader into a node item instance.

Parameters:

is - the input stream 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

deserializeToNodeItem

@NonNull
INodeItem deserializeToNodeItem(@NonNull
                                Reader reader,
                                @NonNull
                                URI documentUri)
                         throws IOException

Read data from the Reader into a node item instance.

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

deserializeToValue

@NonNull
CLASS deserializeToValue(@NonNull
                         Reader reader,
                         @NonNull
                         URI documentUri)
                  throws IOException

Read data from the Reader into a node item instance.

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