Module gov.nist.secauto.metaschema.databind

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

Class MetaschemaXmlWriter

java.lang.Object

gov.nist.secauto.metaschema.databind.io.xml.MetaschemaXmlWriter

All Implemented Interfaces:

IWritingContext<org.codehaus.stax2.XMLStreamWriter2>, IXmlWritingContext

public class MetaschemaXmlWriter
extends Object
implements IXmlWritingContext

Constructor Summary

Constructors

Constructor	Description
MetaschemaXmlWriter(org.codehaus.stax2.XMLStreamWriter2 writer)	Construct a new Module-aware JSON writer.

Method Summary

Modifier and Type	Method	Description
org.codehaus.stax2.XMLStreamWriter2	getWriter()	Get the writer associated with the writing context.
void	write(IAssemblyClassBinding targetDefinition, Object targetObject)	Writes data in a bound object to XML.
void	writeDefinitionValue(IClassBinding targetDefinition, Object targetObject, QName parentName)	Write the data described by the provided targetDefinition as an XML element.
protected void	writeFlagInstance(IBoundFlagInstance targetInstance, Object parentObject)	Write the data described by the provided targetInstance as an XML attribute.
void	writeInstanceValue(IBoundNamedModelInstance targetInstance, Object targetObject, QName parentName)	Write the data described by the provided targetDefinition as an XML element.
protected boolean	writeModelInstanceValues(IBoundNamedModelInstance targetInstance, Object parentObject, QName parentName)	Write the data described by the provided targetInstance as an XML element.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetaschemaXmlWriter

public MetaschemaXmlWriter(@NonNull
                           org.codehaus.stax2.XMLStreamWriter2 writer)

Construct a new Module-aware JSON writer.

Parameters:

writer - the XML stream writer to write with

See Also:

DefaultJsonProblemHandler

Method Detail

getWriter

public org.codehaus.stax2.XMLStreamWriter2 getWriter()

Description copied from interface: IWritingContext

Get the writer associated with the writing context.

Specified by:

getWriter in interface IWritingContext<org.codehaus.stax2.XMLStreamWriter2>

Returns:

the writer

write

public void write(@NonNull
                  IAssemblyClassBinding targetDefinition,
                  @NonNull
                  Object targetObject)
           throws XMLStreamException,
                  IOException

Writes data in a bound object to XML. This assembly must be a root assembly for which a call to IAssemblyDefinition.isRoot() will return true.

Parameters:

targetDefinition - the definition describing the root element data to write

targetObject - the bound object

Throws:

XMLStreamException - if an error occurred while parsing into XML

IOException - if an error occurred while writing the output

writeDefinitionValue

public void writeDefinitionValue(@NonNull
                                 IClassBinding targetDefinition,
                                 @NonNull
                                 Object targetObject,
                                 @NonNull
                                 QName parentName)
                          throws IOException

Description copied from interface: IXmlWritingContext

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

Specified by:

writeDefinitionValue in interface IXmlWritingContext

Parameters:

targetDefinition - the bound Module definition describing the structure of the XML data to write

targetObject - the Java object data to write

parentName - the qualified name of the XML element to write

Throws:

IOException - if an error occurred while writing the XML

writeFlagInstance

protected void writeFlagInstance(@NonNull
                                 IBoundFlagInstance targetInstance,
                                 @NonNull
                                 Object parentObject)
                          throws IOException

Write the data described by the provided targetInstance as an XML attribute.

Parameters:

targetInstance - the model instance that describes the syntax of the data to write

parentObject - the Java object that data written by this method is stored in

Throws:

IOException - if an error occurred while writing the XML

writeModelInstanceValues

protected boolean writeModelInstanceValues(@NonNull
                                           IBoundNamedModelInstance targetInstance,
                                           @NonNull
                                           Object parentObject,
                                           @NonNull
                                           QName parentName)
                                    throws IOException

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

Parameters:

targetInstance - the model instance that describes the syntax of the data to write

parentObject - the Java object that data written by this method is stored in

parentName - the qualified name of the XML data's parent element

Returns:

true id the value was written or false otherwise

Throws:

IOException - if an error occurred while writing the XML

writeInstanceValue

public void writeInstanceValue(@NonNull
                               IBoundNamedModelInstance targetInstance,
                               @NonNull
                               Object targetObject,
                               @NonNull
                               QName parentName)
                        throws IOException

Description copied from interface: IXmlWritingContext

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

Specified by:

writeInstanceValue in interface IXmlWritingContext

Parameters:

targetInstance - the model instance that describes the syntax of the data to write

targetObject - the Java object data to write

parentName - the qualified name of the XML element to write

Throws:

IOException - if an error occurred while writing the XML