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.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 | Field and Description |
---|---|
protected String |
_docTypePublicId
Deprecated.
The system identifier of the document type, if known.
|
protected String |
_docTypeSystemId
Deprecated.
The system identifier of the document type, if known.
|
protected EncodingInfo |
_encodingInfo
Deprecated.
|
protected OutputFormat |
_format
Deprecated.
The output format associated with this serializer.
|
protected boolean |
_indenting
Deprecated.
True if indenting printer.
|
protected Hashtable |
_prefixes
Deprecated.
Association between namespace URIs (keys) and prefixes (values).
|
protected Printer |
_printer
Deprecated.
The printer used for printing text parts.
|
protected boolean |
_started
Deprecated.
If the document has been started (header serialized), this
flag is set to true so it's not started twice.
|
protected Node |
fCurrentNode
Deprecated.
Current node that is being processed
|
protected DOMErrorImpl |
fDOMError
Deprecated.
|
protected DOMErrorHandler |
fDOMErrorHandler
Deprecated.
|
protected LSSerializerFilter |
fDOMFilter
Deprecated.
|
protected short |
features
Deprecated.
|
protected StringBuffer |
fStrBuffer
Deprecated.
Temporary buffer to store character data
|
Modifier | Constructor and Description |
---|---|
protected |
BaseMarkupSerializer(OutputFormat format)
Deprecated.
Protected constructor can only be used by derived class.
|
Modifier and Type | Method and Description |
---|---|
ContentHandler |
asContentHandler()
Deprecated.
Return a
ContentHandler interface into this serializer. |
DocumentHandler |
asDocumentHandler()
Deprecated.
Return a
DocumentHandler interface into this serializer. |
DOMSerializer |
asDOMSerializer()
Deprecated.
Return a
DOMSerializer interface into this serializer. |
void |
attributeDecl(String eName,
String aName,
String type,
String valueDefault,
String value)
Deprecated.
|
void |
characters(char[] chars,
int start,
int length)
Deprecated.
|
protected void |
characters(String text)
Deprecated.
Called to print the text contents in the prevailing element format.
|
protected void |
checkUnboundNamespacePrefixedNode(Node node)
Deprecated.
DOM level 3:
Check a node to determine if it contains unbound namespace prefixes.
|
protected void |
cleanup()
Deprecated.
|
void |
comment(char[] chars,
int start,
int length)
Deprecated.
|
void |
comment(String text)
Deprecated.
|
protected ElementState |
content()
Deprecated.
Must be called by a method about to print any type of content.
|
void |
elementDecl(String name,
String model)
Deprecated.
|
void |
endCDATA()
Deprecated.
|
void |
endDocument()
Deprecated.
Called at the end of the document to wrap it up.
|
void |
endDTD()
Deprecated.
|
void |
endEntity(String name)
Deprecated.
|
void |
endNonEscaping()
Deprecated.
|
void |
endPrefixMapping(String prefix)
Deprecated.
|
void |
endPreserving()
Deprecated.
|
protected ElementState |
enterElementState(String namespaceURI,
String localName,
String rawName,
boolean preserveSpace)
Deprecated.
Enter a new element state for the specified element.
|
void |
externalEntityDecl(String name,
String publicId,
String systemId)
Deprecated.
|
protected void |
fatalError(String message)
Deprecated.
|
protected ElementState |
getElementState()
Deprecated.
Return the state of the current element.
|
protected abstract String |
getEntityRef(int ch)
Deprecated.
Returns the suitable entity reference for this character value,
or null if no such entity exists.
|
protected String |
getPrefix(String namespaceURI)
Deprecated.
Returns the namespace prefix for the specified URI.
|
void |
ignorableWhitespace(char[] chars,
int start,
int length)
Deprecated.
|
void |
internalEntityDecl(String name,
String value)
Deprecated.
|
protected boolean |
isDocumentState()
Deprecated.
Returns true if in the state of the document.
|
protected ElementState |
leaveElementState()
Deprecated.
Leave the current element state and return to the
state of the parent element.
|
protected DOMError |
modifyDOMError(String message,
short severity,
String type,
Node node)
Deprecated.
The method modifies global DOM error object
|
void |
notationDecl(String name,
String publicId,
String systemId)
Deprecated.
|
protected void |
prepare()
Deprecated.
|
protected void |
printCDATAText(String text)
Deprecated.
|
protected void |
printDoctypeURL(String url)
Deprecated.
Print a document type public or system identifier URL.
|
protected void |
printEscaped(int ch)
Deprecated.
|
protected void |
printEscaped(String source)
Deprecated.
Escapes a string so it may be printed as text content or attribute
value.
|
protected void |
printText(char[] chars,
int start,
int length,
boolean preserveSpace,
boolean unescaped)
Deprecated.
Called to print additional text with whitespace handling.
|
protected void |
printText(String text,
boolean preserveSpace,
boolean unescaped)
Deprecated.
|
void |
processingInstruction(String target,
String code)
Deprecated.
|
void |
processingInstructionIO(String target,
String code)
Deprecated.
|
boolean |
reset()
Deprecated.
|
void |
serialize(Document doc)
Deprecated.
Serializes the DOM document using the previously specified
writer and output format.
|
void |
serialize(DocumentFragment frag)
Deprecated.
Serializes the DOM document fragmnt using the previously specified
writer and output format.
|
void |
serialize(Element elem)
Deprecated.
Serializes the DOM element using the previously specified
writer and output format.
|
protected abstract void |
serializeElement(Element elem)
Deprecated.
Called to serializee the DOM element.
|
protected void |
serializeNode(Node node)
Deprecated.
Serialize the DOM node.
|
protected void |
serializePreRoot()
Deprecated.
Comments and PIs cannot be serialized before the root element,
because the root element serializes the document type, which
generally comes first.
|
void |
setDocumentLocator(Locator locator)
Deprecated.
|
void |
setOutputByteStream(OutputStream output)
Deprecated.
Specifies an output stream to which the document should be
serialized.
|
void |
setOutputCharStream(Writer writer)
Deprecated.
Specifies a writer to which the document should be serialized.
|
void |
setOutputFormat(OutputFormat format)
Deprecated.
Specifies an output format for this serializer.
|
void |
skippedEntity(String name)
Deprecated.
|
void |
startCDATA()
Deprecated.
|
void |
startDocument()
Deprecated.
|
void |
startDTD(String name,
String publicId,
String systemId)
Deprecated.
|
void |
startEntity(String name)
Deprecated.
|
void |
startNonEscaping()
Deprecated.
|
void |
startPrefixMapping(String prefix,
String uri)
Deprecated.
|
void |
startPreserving()
Deprecated.
|
protected void |
surrogates(int high,
int low,
boolean inContent)
Deprecated.
|
void |
unparsedEntityDecl(String name,
String publicId,
String systemId,
String notationName)
Deprecated.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
endElement, startElement
endElement, startElement
protected short features
protected DOMErrorHandler fDOMErrorHandler
protected final DOMErrorImpl fDOMError
protected LSSerializerFilter fDOMFilter
protected EncodingInfo _encodingInfo
protected boolean _started
protected Hashtable _prefixes
protected String _docTypePublicId
protected String _docTypeSystemId
protected OutputFormat _format
protected Printer _printer
protected boolean _indenting
protected final StringBuffer fStrBuffer
protected Node fCurrentNode
protected BaseMarkupSerializer(OutputFormat format)
setOutputCharStream(java.io.Writer)
or setOutputByteStream(java.io.OutputStream)
firstpublic 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)
Serializer
setOutputByteStream
in interface Serializer
public void setOutputCharStream(Writer writer)
Serializer
setOutputCharStream
in interface Serializer
public void setOutputFormat(OutputFormat format)
Serializer
setOutputFormat
in interface Serializer
format
- The output format to usepublic boolean reset()
protected void cleanup()
protected void prepare() throws IOException
IOException
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 document fragment 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
protected void serializeNode(Node node) throws IOException
serializeElement(org.w3c.dom.Element)
.node
- The node to serializeIOException
- An I/O exception occured while
serializingserializeElement(org.w3c.dom.Element)
protected ElementState content() throws IOException
IOException
- An I/O exception occurred while
serializingprotected void characters(String text) throws IOException
text
- The text to printIOException
- An I/O exception occured while
serializingprotected abstract String getEntityRef(int ch)
ch
- Character valueprotected abstract void serializeElement(Element elem) throws IOException
elem
- The element to serializeIOException
- An I/O exception occured while
serializingprotected void serializePreRoot() throws IOException
IOException
- An I/O exception occured while
serializingprotected void printCDATAText(String text) throws IOException
IOException
protected void surrogates(int high, int low, boolean inContent) throws IOException
IOException
protected void printText(char[] chars, int start, int length, boolean preserveSpace, boolean unescaped) throws IOException
printText(String,boolean,boolean)
with a call to Printer.breakLine()
for each new line. If spaces are not preserved, the text is
broken at space boundaries if longer than the line width;
Multiple spaces are printed as such, but spaces at beginning
of line are removed.chars
- The text to printstart
- The start offsetlength
- The number of characterspreserveSpace
- Space preserving flagunescaped
- Print unescapedIOException
protected void printText(String text, boolean preserveSpace, boolean unescaped) throws IOException
IOException
protected void printDoctypeURL(String url) throws IOException
printText(char[], int, int, boolean, boolean)
.url
- The document type url to printIOException
protected void printEscaped(int ch) throws IOException
IOException
protected void printEscaped(String source) throws IOException
source
- The string to escapeIOException
protected ElementState getElementState()
protected ElementState enterElementState(String namespaceURI, String localName, String rawName, boolean preserveSpace)
protected ElementState leaveElementState()
protected boolean isDocumentState()
protected String getPrefix(String namespaceURI)
namespaceURI
- The namespace URIprotected DOMError modifyDOMError(String message, short severity, String type, Node node)
message
- severity
- type
- protected void fatalError(String message) throws IOException
IOException
protected void checkUnboundNamespacePrefixedNode(Node node) throws IOException
node
- The node to check for unbound namespace preficesIOException
Copyright © 2017 JBoss by Red Hat. All rights reserved.