Module dev.metaschema.databind

Package dev.metaschema.databind.io

Interface ISerializer<CLASS extends IBoundObject>

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 IBoundObject>
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)	Replace this configuration with the other configuration.
ISerializer<CLASS>	disableFeature(SerializationFeature<?> feature)	Turn off the provided feature.
ISerializer<CLASS>	enableFeature(SerializationFeature<?> feature)	Turn on the provided feature.
default void	serialize(IBoundObject data, File file)	Write data from a bound class instance to the File.
default void	serialize(IBoundObject data, OutputStream os)	Write data from a bound class instance to the OutputStream.
void	serialize(IBoundObject data, Writer writer)	Write data from a bound class instance to the Writer.
default void	serialize(IBoundObject data, Path path, OpenOption... openOptions)	Write data from a bound class instance to the File.
ISerializer<CLASS>	set(SerializationFeature<?> feature, Object value)	Set the value of the provided feature to the provided value.

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

get, getFeatureValues, isFeatureEnabled

Method Details

enableFeature

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

Description copied from interface: IMutableConfiguration

Turn on the provided feature.

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

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

Description copied from interface: IMutableConfiguration

Turn off the provided feature.

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

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

Description copied from interface: IMutableConfiguration

Replace this configuration with the other configuration.

Specified by:

applyConfiguration in interface IMutableConfiguration<CLASS extends IBoundObject>

Parameters:

other - the new configuration

Returns:

the updated configuration

set

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>

Parameters:

feature - the feature to set

value - the value to set

Returns:

the updated configuration

See Also:

• IConfigurationFeature.getValueClass()

serialize

default void serialize(@NonNull
 IBoundObject 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
 IBoundObject 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
 IBoundObject 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
 IBoundObject 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