Module dev.metaschema.databind

Package dev.metaschema.databind.io.json

Class MetaschemaJsonWriter

java.lang.Object

dev.metaschema.databind.io.json.MetaschemaJsonWriter

All Implemented Interfaces:

IWritingContext<com.fasterxml.jackson.core.JsonGenerator>, IJsonWritingContext, IItemWriteHandler

public class MetaschemaJsonWriter
extends Object
implements IJsonWritingContext, IItemWriteHandler

Provides support for writing Metaschema-bound Java objects to JSON format.

This class implements the IItemWriteHandler interface to serialize bound objects to JSON using Jackson's JsonGenerator. It handles flags, fields, assemblies, and choice groups according to the Metaschema JSON serialization rules.

See Also:

• IJsonWritingContext
• JsonGenerator

Nested Class Summary

Nested classes/interfaces inherited from interface dev.metaschema.databind.io.IWritingContext

IWritingContext.ObjectWriter<T extends IFeatureComplexItemValueHandler>

Constructor Summary

Constructors

Constructor	Description
MetaschemaJsonWriter(com.fasterxml.jackson.core.JsonGenerator generator)	Construct a new Module-aware JSON writer.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.core.JsonGenerator	getWriter()	Get the writer associated with the writing context.
void	write(IBoundDefinitionModelComplex definition, IBoundObject item)	Write the data described by the provided targetObject as an XML element.
void	writeChoiceGroupItem(IBoundObject item, IBoundInstanceModelChoiceGroup instance)	Write an item.
void	writeItemAssembly(IBoundObject item, IBoundDefinitionModelAssembly definition)	Write an item.
void	writeItemAssembly(IBoundObject item, IBoundInstanceModelAssembly instance)	Write an item.
void	writeItemAssembly(IBoundObject item, IBoundInstanceModelGroupedAssembly instance)	Write an item.
void	writeItemField(IBoundObject item, IBoundDefinitionModelFieldComplex definition)	Write an item.
void	writeItemField(IBoundObject item, IBoundInstanceModelFieldComplex instance)	Write an item.
void	writeItemField(IBoundObject item, IBoundInstanceModelGroupedField instance)	Write an item.
void	writeItemField(Object item, IBoundInstanceModelFieldScalar instance)	Write an item.
void	writeItemFieldValue(Object item, IBoundFieldValue fieldValue)	Write an item.
void	writeItemFlag(Object item, IBoundInstanceFlag instance)	Write an item.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MetaschemaJsonWriter

public MetaschemaJsonWriter(@NonNull @NotOwning
 com.fasterxml.jackson.core.JsonGenerator generator)

Construct a new Module-aware JSON writer.

Parameters:

generator - the JSON generator to write with. The caller retains ownership of this generator and is responsible for closing it.

See Also:

• DefaultJsonProblemHandler

Method Details

getWriter

public com.fasterxml.jackson.core.JsonGenerator getWriter()

Description copied from interface: IWritingContext

Get the writer associated with the writing context.

Specified by:

getWriter in interface IWritingContext<com.fasterxml.jackson.core.JsonGenerator>

Returns:

the writer

write

public void write(@NonNull
 IBoundDefinitionModelComplex definition,
 @NonNull
 IBoundObject item)
           throws IOException

Description copied from interface: IWritingContext

Write the data described by the provided targetObject as an XML element.

Specified by:

write in interface IWritingContext<com.fasterxml.jackson.core.JsonGenerator>

Parameters:

definition - the bound Module definition describing the data to write

item - the Java object data to write

Throws:

IOException - if an error occurred while writing

writeItemFlag

public void writeItemFlag(Object item,
 IBoundInstanceFlag instance)
                   throws IOException

Description copied from interface: IItemWriteHandler

Write an item.

Specified by:

writeItemFlag in interface IItemWriteHandler

Parameters:

item - the Java object representing the item to write

instance - the flag instance

Throws:

IOException - if an error occurred while parsing

writeItemField

public void writeItemField(Object item,
 IBoundInstanceModelFieldScalar instance)
                    throws IOException

Description copied from interface: IItemWriteHandler

Write an item.

Specified by:

writeItemField in interface IItemWriteHandler

Parameters:

item - the Java object representing the item to write

instance - the field instance

Throws:

IOException - if an error occurred while parsing

writeItemField

public void writeItemField(IBoundObject item,
 IBoundInstanceModelFieldComplex instance)
                    throws IOException

Description copied from interface: IItemWriteHandler

Write an item.

Specified by:

writeItemField in interface IItemWriteHandler

Parameters:

item - the Java object representing the item to write

instance - the field instance

Throws:

IOException - if an error occurred while parsing

writeItemField

public void writeItemField(IBoundObject item,
 IBoundInstanceModelGroupedField instance)
                    throws IOException

Description copied from interface: IItemWriteHandler

Write an item.

Specified by:

writeItemField in interface IItemWriteHandler

Parameters:

item - the Java object representing the item to write

instance - the field instance

Throws:

IOException - if an error occurred while parsing

writeItemField

public void writeItemField(IBoundObject item,
 IBoundDefinitionModelFieldComplex definition)
                    throws IOException

Description copied from interface: IItemWriteHandler

Write an item.

Specified by:

writeItemField in interface IItemWriteHandler

Parameters:

item - the Java object representing the item to write

definition - the field instance

Throws:

IOException - if an error occurred while parsing

writeItemFieldValue

public void writeItemFieldValue(Object item,
 IBoundFieldValue fieldValue)
                         throws IOException

Description copied from interface: IItemWriteHandler

Write an item.

Specified by:

writeItemFieldValue in interface IItemWriteHandler

Parameters:

item - the Java object representing the item to write

fieldValue - the field value instance

Throws:

IOException - if an error occurred while parsing

writeItemAssembly

public void writeItemAssembly(IBoundObject item,
 IBoundInstanceModelAssembly instance)
                       throws IOException

Description copied from interface: IItemWriteHandler

Write an item.

Specified by:

writeItemAssembly in interface IItemWriteHandler

Parameters:

item - the Java object representing the item to write

instance - the assembly instance

Throws:

IOException - if an error occurred while parsing

writeItemAssembly

public void writeItemAssembly(IBoundObject item,
 IBoundInstanceModelGroupedAssembly instance)
                       throws IOException

Description copied from interface: IItemWriteHandler

Write an item.

Specified by:

writeItemAssembly in interface IItemWriteHandler

Parameters:

item - the Java object representing the item to write

instance - the assembly instance

Throws:

IOException - if an error occurred while parsing

writeItemAssembly

public void writeItemAssembly(IBoundObject item,
 IBoundDefinitionModelAssembly definition)
                       throws IOException

Description copied from interface: IItemWriteHandler

Write an item.

Specified by:

writeItemAssembly in interface IItemWriteHandler

Parameters:

item - the Java object representing the item to write

definition - the assembly instance

Throws:

IOException - if an error occurred while parsing

writeChoiceGroupItem

public void writeChoiceGroupItem(IBoundObject item,
 IBoundInstanceModelChoiceGroup instance)
                          throws IOException

Description copied from interface: IItemWriteHandler

Write an item.

Specified by:

writeChoiceGroupItem in interface IItemWriteHandler

Parameters:

item - the Java object representing the item to write

instance - the choice group instance

Throws:

IOException - if an error occurred while parsing