Package org.apache.jackrabbit.vault.util.xml.serialize

Class XMLSerializer

java.lang.Object

org.apache.jackrabbit.vault.util.xml.serialize.BaseMarkupSerializer

org.apache.jackrabbit.vault.util.xml.serialize.XMLSerializer

All Implemented Interfaces:

DOMSerializer, Serializer, org.xml.sax.ContentHandler, org.xml.sax.DocumentHandler, org.xml.sax.DTDHandler, org.xml.sax.ext.DeclHandler, org.xml.sax.ext.LexicalHandler

public class XMLSerializer
extends BaseMarkupSerializer

ASF Note: This class and dependencies were copied from the sun jdk1.5 source base. The original serializer is extended by a new OutputFormat setting that allows to break the line for each attribute. additionally, all attribute names are sorted alphabetically. Some Features were removed to limit the number of dependent classes:

• dom filter support
• all text nodes as CDATA feature
• skip attribute default values feature
• entity node reference feature

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. SAX serializing is done by firing SAX events and using the serializer as a document handler. DOM serializing is done by calling BaseMarkupSerializer.serialize(Document) or by using DOM Level 3

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.

See Also:

Serializer

Constructor Summary

Constructors

Constructor	Description
XMLSerializer()	Constructs a new serializer.
XMLSerializer(java.io.OutputStream output, OutputFormat format)	Constructs a new serializer that writes to the specified output stream using the specified output format.
XMLSerializer(java.io.Writer writer, OutputFormat format)	Constructs a new serializer that writes to the specified writer using the specified output format.
XMLSerializer(OutputFormat format)	Constructs a new serializer.

Method Summary

Modifier and Type	Method	Description
void	endElement(java.lang.String tagName)
void	endElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String rawName)
void	endElementIO(java.lang.String namespaceURI, java.lang.String localName, java.lang.String rawName)
boolean	reset()
void	setNamespaces(boolean namespaces)	This methods turns on namespace fixup algorithm during DOM serialization.
void	setOutputFormat(OutputFormat format)	Specifies an output format for this serializer.
void	startElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String rawName, org.xml.sax.Attributes attrs)
void	startElement(java.lang.String tagName, org.xml.sax.AttributeList attrs)

Methods inherited from class org.apache.jackrabbit.vault.util.xml.serialize.BaseMarkupSerializer

asContentHandler, asDocumentHandler, asDOMSerializer, attributeDecl, characters, comment, comment, elementDecl, endCDATA, endDocument, endDTD, endEntity, endNonEscaping, endPrefixMapping, endPreserving, externalEntityDecl, ignorableWhitespace, internalEntityDecl, notationDecl, processingInstruction, processingInstructionIO, serialize, serialize, serialize, setDocumentLocator, setOutputByteStream, setOutputCharStream, skippedEntity, startCDATA, startDocument, startDTD, startEntity, startNonEscaping, startPrefixMapping, startPreserving, unparsedEntityDecl

Methods inherited from class java.lang.Object

equals, 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(java.io.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.

The specified writer will not be closed by this class.

Parameters:

writer - The writer to use

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

XMLSerializer

public XMLSerializer(java.io.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.

The specified stream will not be closed by this class.

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)

Description copied from interface: Serializer

Specifies an output format for this serializer. It the serializer has already been associated with an output format, it will switch to the new format. This method should not be called while the serializer is in the process of serializing a document.

Specified by:

setOutputFormat in interface Serializer

Overrides:

setOutputFormat in class BaseMarkupSerializer

Parameters:

format - The output format to use

setNamespaces

public void setNamespaces(boolean namespaces)

This methods turns on namespace fixup algorithm during DOM serialization.

Parameters:

namespaces -

startElement

public void startElement(java.lang.String namespaceURI,
                         java.lang.String localName,
                         java.lang.String rawName,
                         org.xml.sax.Attributes attrs)
                  throws org.xml.sax.SAXException

Throws:

org.xml.sax.SAXException

endElement

public void endElement(java.lang.String namespaceURI,
                       java.lang.String localName,
                       java.lang.String rawName)
                throws org.xml.sax.SAXException

Throws:

org.xml.sax.SAXException

endElementIO

public void endElementIO(java.lang.String namespaceURI,
                         java.lang.String localName,
                         java.lang.String rawName)
                  throws java.io.IOException

Throws:

java.io.IOException

startElement

public void startElement(java.lang.String tagName,
                         org.xml.sax.AttributeList attrs)
                  throws org.xml.sax.SAXException

Throws:

org.xml.sax.SAXException

endElement

public void endElement(java.lang.String tagName)
                throws org.xml.sax.SAXException

Throws:

org.xml.sax.SAXException

reset

public boolean reset()

Overrides:

reset in class BaseMarkupSerializer