public abstract class BaseMarkupSerializer extends Object implements ContentHandler, DocumentHandler, LexicalHandler, DTDHandler, DeclHandler, DOMSerializer, Serializer
The serializer must be initialized with the proper writer and
output format before it can be used by calling setOutputCharStream(java.io.Writer)
or setOutputByteStream(java.io.OutputStream)
for the writer and setOutputFormat(org.apache.jackrabbit.vault.util.xml.serialize.OutputFormat)
for the output format.
The serializer can be reused any number of times, but cannot be used concurrently by two threads.
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 serialize(Document)
and SAX serializing is done by firing
SAX events and using the serializer as a document handler.
This also applies to derived class.
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.
When indenting, the serializer is capable of detecting seemingly element content, and serializing these elements indented on separate lines. An element is serialized indented when it is the first or last child of an element, or immediate following or preceding another element.
Serializer
,
LSSerializer
Modifier and Type | Method and Description |
---|---|
ContentHandler |
asContentHandler()
Return a
ContentHandler interface into this serializer. |
DocumentHandler |
asDocumentHandler()
Return a
DocumentHandler interface into this serializer. |
DOMSerializer |
asDOMSerializer()
Return a
DOMSerializer interface into this serializer. |
void |
attributeDecl(String eName,
String aName,
String type,
String valueDefault,
String value) |
void |
characters(char[] chars,
int start,
int length) |
void |
comment(char[] chars,
int start,
int length) |
void |
comment(String text) |
void |
elementDecl(String name,
String model) |
void |
endCDATA() |
void |
endDocument()
Called at the end of the document to wrap it up.
|
void |
endDTD() |
void |
endEntity(String name) |
void |
endNonEscaping() |
void |
endPrefixMapping(String prefix) |
void |
endPreserving() |
void |
externalEntityDecl(String name,
String publicId,
String systemId) |
void |
ignorableWhitespace(char[] chars,
int start,
int length) |
void |
internalEntityDecl(String name,
String value) |
void |
notationDecl(String name,
String publicId,
String systemId) |
void |
processingInstruction(String target,
String code) |
void |
processingInstructionIO(String target,
String code) |
boolean |
reset() |
void |
serialize(Document doc)
Serializes the DOM document using the previously specified
writer and output format.
|
void |
serialize(DocumentFragment frag)
Serializes the DOM document fragmnt using the previously specified
writer and output format.
|
void |
serialize(Element elem)
Serializes the DOM element using the previously specified
writer and output format.
|
void |
setDocumentLocator(Locator locator) |
void |
setOutputByteStream(OutputStream output)
The specified stream will not be closed by this class.
|
void |
setOutputCharStream(Writer writer)
The specified writer will not be closed by this class.
|
void |
setOutputFormat(OutputFormat format)
Specifies an output format for this serializer.
|
void |
skippedEntity(String name) |
void |
startCDATA() |
void |
startDocument() |
void |
startDTD(String name,
String publicId,
String systemId) |
void |
startEntity(String name) |
void |
startNonEscaping() |
void |
startPrefixMapping(String prefix,
String uri) |
void |
startPreserving() |
void |
unparsedEntityDecl(String name,
String publicId,
String systemId,
String notationName) |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
endElement, startElement
endElement, startElement
public DocumentHandler asDocumentHandler() throws IOException
Serializer
DocumentHandler
interface into this serializer.
If the serializer does not support the DocumentHandler
interface, it should return null.asDocumentHandler
in interface Serializer
IOException
public ContentHandler asContentHandler() throws IOException
Serializer
ContentHandler
interface into this serializer.
If the serializer does not support the ContentHandler
interface, it should return null.asContentHandler
in interface Serializer
IOException
public DOMSerializer asDOMSerializer() throws IOException
Serializer
DOMSerializer
interface into this serializer.
If the serializer does not support the DOMSerializer
interface, it should return null.asDOMSerializer
in interface Serializer
IOException
public void setOutputByteStream(OutputStream output)
The specified stream will not be closed by this class.
setOutputByteStream
in interface Serializer
public void setOutputCharStream(Writer writer)
The specified writer will not be closed by this class.
setOutputCharStream
in interface Serializer
public void setOutputFormat(OutputFormat format)
Serializer
setOutputFormat
in interface Serializer
format
- The output format to usepublic boolean reset()
public void serialize(Element elem) throws IOException
serialize
in interface DOMSerializer
elem
- The element to serializeIOException
- An I/O exception occured while
serializingpublic void serialize(DocumentFragment frag) throws IOException
serialize
in interface DOMSerializer
frag
- The element to serializeIOException
- An I/O exception occured while
serializingpublic void serialize(Document doc) throws IOException
serialize
in interface DOMSerializer
doc
- The document to serializeIOException
- An I/O exception occured while
serializingpublic void startDocument() throws SAXException
startDocument
in interface ContentHandler
startDocument
in interface DocumentHandler
SAXException
public void characters(char[] chars, int start, int length) throws SAXException
characters
in interface ContentHandler
characters
in interface DocumentHandler
SAXException
public void ignorableWhitespace(char[] chars, int start, int length) throws SAXException
ignorableWhitespace
in interface ContentHandler
ignorableWhitespace
in interface DocumentHandler
SAXException
public final void processingInstruction(String target, String code) throws SAXException
processingInstruction
in interface ContentHandler
processingInstruction
in interface DocumentHandler
SAXException
public void processingInstructionIO(String target, String code) throws IOException
IOException
public void comment(char[] chars, int start, int length) throws SAXException
comment
in interface LexicalHandler
SAXException
public void comment(String text) throws IOException
IOException
public void startCDATA()
startCDATA
in interface LexicalHandler
public void endCDATA()
endCDATA
in interface LexicalHandler
public void startNonEscaping()
public void endNonEscaping()
public void startPreserving()
public void endPreserving()
public void endDocument() throws SAXException
endDocument
in interface ContentHandler
endDocument
in interface DocumentHandler
SAXException
- An I/O exception occured during
serializingpublic void startEntity(String name)
startEntity
in interface LexicalHandler
public void endEntity(String name)
endEntity
in interface LexicalHandler
public void setDocumentLocator(Locator locator)
setDocumentLocator
in interface ContentHandler
setDocumentLocator
in interface DocumentHandler
public void skippedEntity(String name) throws SAXException
skippedEntity
in interface ContentHandler
SAXException
public void startPrefixMapping(String prefix, String uri) throws SAXException
startPrefixMapping
in interface ContentHandler
SAXException
public void endPrefixMapping(String prefix) throws SAXException
endPrefixMapping
in interface ContentHandler
SAXException
public final void startDTD(String name, String publicId, String systemId) throws SAXException
startDTD
in interface LexicalHandler
SAXException
public void endDTD()
endDTD
in interface LexicalHandler
public void elementDecl(String name, String model) throws SAXException
elementDecl
in interface DeclHandler
SAXException
public void attributeDecl(String eName, String aName, String type, String valueDefault, String value) throws SAXException
attributeDecl
in interface DeclHandler
SAXException
public void internalEntityDecl(String name, String value) throws SAXException
internalEntityDecl
in interface DeclHandler
SAXException
public void externalEntityDecl(String name, String publicId, String systemId) throws SAXException
externalEntityDecl
in interface DeclHandler
SAXException
public void unparsedEntityDecl(String name, String publicId, String systemId, String notationName) throws SAXException
unparsedEntityDecl
in interface DTDHandler
SAXException
public void notationDecl(String name, String publicId, String systemId) throws SAXException
notationDecl
in interface DTDHandler
SAXException
Copyright © 2010 - 2020 Adobe. All Rights Reserved