sirius.kernel.xml

Class XMLGenerator

java.lang.Object

sirius.kernel.xml.AbstractStructuredOutput

sirius.kernel.xml.XMLStructuredOutput

sirius.kernel.xml.XMLGenerator

All Implemented Interfaces:

StructuredOutput

@ParametersAreNonnullByDefault
public class XMLGenerator
extends XMLStructuredOutput

Uses an XMLStructuredOutput with a temporary buffer to generate XML into a String.

Nested Class Summary

Nested classes/interfaces inherited from class sirius.kernel.xml.AbstractStructuredOutput

AbstractStructuredOutput.Element, AbstractStructuredOutput.ElementType, AbstractStructuredOutput.TagBuilder

Field Summary

Fields inherited from class sirius.kernel.xml.XMLStructuredOutput

out

Fields inherited from class sirius.kernel.xml.AbstractStructuredOutput

nesting

Constructor Summary

Constructors

Constructor and Description
XMLGenerator() Creates a new XMLGenerator which uses an internal buffer to store the XML.

Method Summary

Modifier and Type	Method and Description
static Document	createDocument(String namespaceURI, String qualifiedName, DocumentType docType) Creates a new xml document.
String	generate() Returns the generated XML as string, using UTF-8 as encoding.
String	generate(String encoding) Returns the generated XML as string using the given encoding.
static void	writeXML(Node doc, Writer writer, String encoding) Writes the given XML document to the given writer.
static void	writeXML(Node doc, Writer writer, String encoding, boolean omitXMLDeclaration) Writes the given XML document to the given writer.

Methods inherited from class sirius.kernel.xml.XMLStructuredOutput

beginOutput, beginOutput, beginResult, beginResult, buildBegin, close, endArray, endObject, endOutput, endResult, propertyIfFilled, startArray, startObject, text, writeProperty

Methods inherited from class sirius.kernel.xml.AbstractStructuredOutput

array, array, beginArray, beginObject, beginObject, buildObject, endArray, endObject, getCurrentType, isCurrentObjectEmpty, nullsafeProperty, property

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLGenerator

public XMLGenerator()

Creates a new XMLGenerator which uses an internal buffer to store the XML.

Method Detail

generate

public String generate(String encoding)

Returns the generated XML as string using the given encoding.

Parameters:

encoding - the encoding to use when converting the binary buffer to a String.

Returns:

a string representation of the generated XML.

generate

public String generate()

Returns the generated XML as string, using UTF-8 as encoding.

Returns:

a string representation of the generated XML.

writeXML

public static void writeXML(Node doc,
                            Writer writer,
                            String encoding)
                     throws TransformerException

Writes the given XML document to the given writer.

Parameters:

doc - the XML document to write

writer - the target to write the XML to

encoding - the encoding used to write the XML

Throws:

TransformerException - if an exception during serialization occurs.

writeXML

public static void writeXML(Node doc,
                            Writer writer,
                            String encoding,
                            boolean omitXMLDeclaration)
                     throws TransformerException

Writes the given XML document to the given writer.

Parameters:

doc - the XML document to write

writer - the target to write the XML to

encoding - the encoding used to write the XML

omitXMLDeclaration - determines whether the XML declaration should be skipped (true) or not (false).

Throws:

TransformerException - if an exception during serialization occurs.

createDocument

public static Document createDocument(@Nullable
                                      String namespaceURI,
                                      String qualifiedName,
                                      @Nullable
                                      DocumentType docType)
                               throws ParserConfigurationException

Creates a new xml document.

Parameters:

namespaceURI - defines the uri of the default namespace used by the resulting document

qualifiedName - returns the name of the root element of the resulting document

docType - specifies the DocumentType used by the resulting document

Returns:

a Document created by the given specifications

Throws:

ParserConfigurationException - if no suitable xml implementation was found.