org.apache.geronimo.system.configuration
Class XMLSerializer

java.lang.Object
  org.apache.geronimo.system.configuration.BaseMarkupSerializer
      org.apache.geronimo.system.configuration.XMLSerializer

public class XMLSerializer
extends BaseMarkupSerializer

Implements an XML serializer supporting both DOM and SAX pretty serializing. For usage instructions see Serializer.

If an output stream is used, the encoding is taken from the output format (defaults to UTF-8). If a writer is used, make sure the writer uses the same encoding (if applies) as specified in the output format.

The serializer supports both DOM and SAX. DOM serializing is done by calling BaseMarkupSerializer.serialize(org.w3c.dom.Element) and SAX serializing is done by firing SAX events and using the serializer as a document handler.

If an I/O exception occurs while serializing, the serializer will not throw an exception directly, but only throw it at the end of serializing (either DOM or SAX's DocumentHandler.endDocument().

For elements that are not specified as whitespace preserving, the serializer will potentially break long text lines at space boundaries, indent lines, and serialize elements on separate lines. Line terminators will be regarded as spaces, and spaces at beginning of line will be stripped.

Author:

Assaf Arkin

See Also:

Serializer

Field Summary

Fields inherited from class org.apache.geronimo.system.configuration.BaseMarkupSerializer

docTypePublicId, docTypeSystemId, format, indenting, prefixes, printer, started

Constructor Summary

XMLSerializer()
Constructs a new serializer.

XMLSerializer(OutputFormat format)
Constructs a new serializer.

XMLSerializer(OutputStream output, OutputFormat format)
Constructs a new serializer that writes to the specified output stream using the specified output format.

XMLSerializer(Writer writer, OutputFormat format)
Constructs a new serializer that writes to the specified writer using the specified output format.

Method Summary

void	endElement(String tagName)
void	endElement(String namespaceURI, String localName, String rawName)
void	endElementIO(String namespaceURI, String localName, String rawName)
protected String	getEntityRef(int ch) Returns the suitable entity reference for this character value, or null if no such entity exists.
protected void	serializeElement(Element elem) Called to serialize a DOM element.
void	setOutputFormat(OutputFormat format)
protected void	startDocument(String rootTagName) Called to serialize the document's DOCTYPE by the root element.
void	startElement(String tagName, AttributeList attrs)
void	startElement(String namespaceURI, String localName, String rawName, Attributes attrs)

Methods inherited from class org.apache.geronimo.system.configuration.BaseMarkupSerializer

attributeDecl, characters, characters, comment, comment, content, elementDecl, endCDATA, endDocument, endDTD, endEntity, endNonEscaping, endPrefixMapping, endPreserving, enterElementState, externalEntityDecl, getElementState, getPrefix, ignorableWhitespace, internalEntityDecl, isDocumentState, leaveElementState, notationDecl, prepare, printDoctypeURL, printEscaped, printEscaped, printText, printText, processingInstruction, processingInstructionIO, reset, serialize, serialize, serialize, serializeNode, serializePreRoot, setDocumentLocator, setOutputByteStream, setOutputCharStream, skippedEntity, startCDATA, startDocument, startDTD, startEntity, startNonEscaping, startPrefixMapping, startPreserving, unparsedEntityDecl

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLSerializer

public XMLSerializer()

Constructs a new serializer. The serializer cannot be used without calling BaseMarkupSerializer.setOutputCharStream(java.io.Writer) or BaseMarkupSerializer.setOutputByteStream(java.io.OutputStream) first.

XMLSerializer

public XMLSerializer(OutputFormat format)

Constructs a new serializer. The serializer cannot be used without calling BaseMarkupSerializer.setOutputCharStream(java.io.Writer) or BaseMarkupSerializer.setOutputByteStream(java.io.OutputStream) first.

XMLSerializer

public XMLSerializer(Writer writer,
                     OutputFormat format)

Constructs a new serializer that writes to the specified writer using the specified output format. If format is null, will use a default output format.

Parameters:

writer - The writer to use

format - The output format to use, null for the default

XMLSerializer

public XMLSerializer(OutputStream output,
                     OutputFormat format)

Constructs a new serializer that writes to the specified output stream using the specified output format. If format is null, will use a default output format.

Parameters:

output - The output stream to use

format - The output format to use, null for the default

Method Detail

setOutputFormat

public void setOutputFormat(OutputFormat format)

Overrides:

setOutputFormat in class BaseMarkupSerializer

startElement

public void startElement(String namespaceURI,
                         String localName,
                         String rawName,
                         Attributes attrs)
                  throws SAXException

Throws:

SAXException

endElement

public void endElement(String namespaceURI,
                       String localName,
                       String rawName)
                throws SAXException

Throws:

SAXException

endElementIO

public void endElementIO(String namespaceURI,
                         String localName,
                         String rawName)
                  throws IOException

Throws:

IOException

startElement

public void startElement(String tagName,
                         AttributeList attrs)
                  throws SAXException

Throws:

SAXException

endElement

public void endElement(String tagName)
                throws SAXException

Throws:

SAXException

startDocument

protected void startDocument(String rootTagName)
                      throws IOException

Called to serialize the document's DOCTYPE by the root element. The document type declaration must name the root element, but the root element is only known when that element is serialized, and not at the start of the document.

This method will check if it has not been called before (BaseMarkupSerializer.started), will serialize the document type declaration, and will serialize all pre-root comments and PIs that were accumulated in the document (see BaseMarkupSerializer.serializePreRoot()). Pre-root will be serialized even if this is not the first root element of the document.

Throws:

IOException

serializeElement

protected void serializeElement(Element elem)
                         throws IOException

Called to serialize a DOM element. Equivalent to calling startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes), endElement(java.lang.String, java.lang.String, java.lang.String) and serializing everything inbetween, but better optimized.

Specified by:

serializeElement in class BaseMarkupSerializer

Parameters:

elem - The element to serialize

Throws:

IOException - An I/O exception occured while serializing

getEntityRef

protected String getEntityRef(int ch)

Description copied from class: BaseMarkupSerializer

Returns the suitable entity reference for this character value, or null if no such entity exists. Calling this method with '&' will return "&".

Specified by:

getEntityRef in class BaseMarkupSerializer

Parameters:

ch - Character value

Returns:

Character entity name, or null