Module gov.nist.secauto.metaschema.databind

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

Interface ISerializer<CLASS>

Type Parameters:

CLASS - the Java type from which data can be written

All Superinterfaces:

IConfiguration<SerializationFeature<?>>, IMutableConfiguration<SerializationFeature<?>>

All Known Implementing Classes:

AbstractSerializer, DefaultJsonSerializer, DefaultXmlSerializer, DefaultYamlSerializer

public interface ISerializer<CLASS>
extends IMutableConfiguration<SerializationFeature<?>>

Implementations of this interface are able to write data in a bound object instance of the parameterized type to a structured data format.

Method Summary

Modifier and Type	Method	Description
ISerializer<CLASS>	applyConfiguration(IConfiguration<SerializationFeature<?>> other)
ISerializer<CLASS>	disableFeature(SerializationFeature<?> feature)
ISerializer<CLASS>	enableFeature(SerializationFeature<?> feature)
default void	serialize(CLASS data, File file)	Write data from a bound class instance to the File.
default void	serialize(CLASS data, OutputStream os)	Write data from a bound class instance to the OutputStream.
void	serialize(CLASS data, Writer writer)	Write data from a bound class instance to the Writer.
default void	serialize(CLASS data, Path path, OpenOption... openOptions)	Write data from a bound class instance to the File.
ISerializer<CLASS>	set(SerializationFeature<?> feature, Object value)

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

get, getFeatureValues, isFeatureEnabled

Method Detail

enableFeature

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

Specified by:

enableFeature in interface IMutableConfiguration<CLASS>

disableFeature

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

Specified by:

disableFeature in interface IMutableConfiguration<CLASS>

applyConfiguration

ISerializer<CLASS> applyConfiguration(IConfiguration<SerializationFeature<?>> other)

Specified by:

applyConfiguration in interface IMutableConfiguration<CLASS>

set

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

Specified by:

set in interface IMutableConfiguration<CLASS>

serialize

default void serialize(@NonNull
                       CLASS data,
                       @NonNull
                       OutputStream os)
                throws IOException

Write data from a bound class instance to the OutputStream.

This method does not have ownership of the the provided output stream and will not close it.

Parameters:

data - the instance data

os - the output stream to write to

Throws:

IOException - if an error occurred while writing data to the stream

serialize

default void serialize(@NonNull
                       CLASS data,
                       @NonNull
                       Path path,
                       OpenOption... openOptions)
                throws IOException

Write data from a bound class instance to the File.

Parameters:

data - the instance data

path - the file to write to

openOptions - options specifying how the file is opened

Throws:

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

serialize

default void serialize(@NonNull
                       CLASS data,
                       @NonNull
                       File file)
                throws IOException

Write data from a bound class instance to the File.

Parameters:

data - the instance data

file - the file to write to

Throws:

IOException - if an error occurred while writing data to the stream

serialize

void serialize(@NonNull
               CLASS data,
               @NonNull
               Writer writer)
        throws IOException

Write data from a bound class instance to the Writer.

Parameters:

data - the instance data

writer - the writer to write to

Throws:

IOException - if an error occurred while writing data to the stream