public class TextSerializer extends BaseMarkupSerializer
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()
.
Serializer
_docTypePublicId, _docTypeSystemId, _encodingInfo, _format, _indenting, _prefixes, _printer, _started, fCurrentNode, fDOMError, fDOMErrorHandler, fDOMFilter, features, fStrBuffer
Constructor and Description |
---|
TextSerializer()
Deprecated.
Constructs a new serializer.
|
Modifier and Type | Method and Description |
---|---|
void |
characters(char[] chars,
int start,
int length)
Deprecated.
Receive notification of character data.
|
protected void |
characters(java.lang.String text,
boolean unescaped)
Deprecated.
|
void |
comment(char[] chars,
int start,
int length)
Deprecated.
Report an XML comment anywhere in the document.
|
void |
comment(java.lang.String text)
Deprecated.
|
protected ElementState |
content()
Deprecated.
Must be called by a method about to print any type of content.
|
void |
endElement(java.lang.String tagName)
Deprecated.
Receive notification of the end of an element.
|
void |
endElement(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String rawName)
Deprecated.
Receive notification of the end of an element.
|
void |
endElementIO(java.lang.String tagName)
Deprecated.
|
protected java.lang.String |
getEntityRef(int ch)
Deprecated.
Returns the suitable entity reference for this character value,
or null if no such entity exists.
|
void |
processingInstructionIO(java.lang.String target,
java.lang.String code)
Deprecated.
|
protected void |
serializeElement(org.w3c.dom.Element elem)
Deprecated.
Called to serialize a DOM element.
|
protected void |
serializeNode(org.w3c.dom.Node node)
Deprecated.
Serialize the DOM node.
|
void |
setOutputFormat(OutputFormat format)
Deprecated.
Specifies an output format for this serializer.
|
protected void |
startDocument(java.lang.String rootTagName)
Deprecated.
Called to serialize the document's DOCTYPE by the root element.
|
void |
startElement(java.lang.String tagName,
org.xml.sax.AttributeList attrs)
Deprecated.
Receive notification of the beginning of an element.
|
void |
startElement(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String rawName,
org.xml.sax.Attributes attrs)
Deprecated.
Receive notification of the beginning of an element.
|
asContentHandler, asDocumentHandler, asDOMSerializer, attributeDecl, characters, checkUnboundNamespacePrefixedNode, cleanup, elementDecl, endCDATA, endDocument, endDTD, endEntity, endNonEscaping, endPrefixMapping, endPreserving, enterElementState, externalEntityDecl, fatalError, getElementState, getPrefix, ignorableWhitespace, internalEntityDecl, isDocumentState, leaveElementState, modifyDOMError, notationDecl, prepare, printCDATAText, printDoctypeURL, printEscaped, printEscaped, printText, printText, processingInstruction, reset, serialize, serialize, serialize, serializePreRoot, setDocumentLocator, setOutputByteStream, setOutputCharStream, skippedEntity, startCDATA, startDocument, startDTD, startEntity, startNonEscaping, startPrefixMapping, startPreserving, surrogates, unparsedEntityDecl
public TextSerializer()
BaseMarkupSerializer.setOutputCharStream(java.io.Writer)
or BaseMarkupSerializer.setOutputByteStream(java.io.OutputStream)
first.public void setOutputFormat(OutputFormat format)
Serializer
setOutputFormat
in interface Serializer
setOutputFormat
in class BaseMarkupSerializer
format
- The output format to usepublic void startElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String rawName, org.xml.sax.Attributes attrs) throws org.xml.sax.SAXException
org.xml.sax.ContentHandler
The Parser will invoke this method at the beginning of every
element in the XML document; there will be a corresponding
endElement
event for every startElement event
(even when the element is empty). All of the element's content will be
reported, in order, before the corresponding endElement
event.
This event allows up to three name components for each element:
Any or all of these may be provided, depending on the values of the http://xml.org/sax/features/namespaces and the http://xml.org/sax/features/namespace-prefixes properties:
Note that the attribute list provided will contain only
attributes with explicit values (specified or defaulted):
#IMPLIED attributes will be omitted. The attribute list
will contain attributes used for Namespace declarations
(xmlns* attributes) only if the
http://xml.org/sax/features/namespace-prefixes
property is true (it is false by default, and support for a
true value is optional).
Like characters()
, attribute values may have
characters that need more than one char
value.
namespaceURI
- the Namespace URI, or the empty string if the
element has no Namespace URI or if Namespace
processing is not being performedlocalName
- the local name (without prefix), or the
empty string if Namespace processing is not being
performedrawName
- the qualified name (with prefix), or the
empty string if qualified names are not availableattrs
- the attributes attached to the element. If
there are no attributes, it shall be an empty
Attributes object. The value of this object after
startElement returns is undefinedorg.xml.sax.SAXException
- any SAX exception, possibly
wrapping another exceptionContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String)
,
Attributes
,
AttributesImpl
public void endElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String rawName) throws org.xml.sax.SAXException
org.xml.sax.ContentHandler
The SAX parser will invoke this method at the end of every
element in the XML document; there will be a corresponding
startElement
event for every endElement
event (even when the element is empty).
For information on the names, see startElement.
namespaceURI
- the Namespace URI, or the empty string if the
element has no Namespace URI or if Namespace
processing is not being performedlocalName
- the local name (without prefix), or the
empty string if Namespace processing is not being
performedrawName
- the qualified XML name (with prefix), or the
empty string if qualified names are not availableorg.xml.sax.SAXException
- any SAX exception, possibly
wrapping another exceptionpublic void startElement(java.lang.String tagName, org.xml.sax.AttributeList attrs) throws org.xml.sax.SAXException
org.xml.sax.DocumentHandler
The Parser will invoke this method at the beginning of every element in the XML document; there will be a corresponding endElement() event for every startElement() event (even when the element is empty). All of the element's content will be reported, in order, before the corresponding endElement() event.
If the element name has a namespace prefix, the prefix will still be attached. Note that the attribute list provided will contain only attributes with explicit values (specified or defaulted): #IMPLIED attributes will be omitted.
tagName
- The element type name.attrs
- The attributes attached to the element, if any.org.xml.sax.SAXException
- Any SAX exception, possibly
wrapping another exception.DocumentHandler.endElement(java.lang.String)
,
AttributeList
public void endElement(java.lang.String tagName) throws org.xml.sax.SAXException
org.xml.sax.DocumentHandler
The SAX parser will invoke this method at the end of every element in the XML document; there will be a corresponding startElement() event for every endElement() event (even when the element is empty).
If the element name has a namespace prefix, the prefix will still be attached to the name.
tagName
- The element type nameorg.xml.sax.SAXException
- Any SAX exception, possibly
wrapping another exception.public void endElementIO(java.lang.String tagName) throws java.io.IOException
java.io.IOException
public void processingInstructionIO(java.lang.String target, java.lang.String code) throws java.io.IOException
processingInstructionIO
in class BaseMarkupSerializer
java.io.IOException
public void comment(java.lang.String text)
comment
in class BaseMarkupSerializer
public void comment(char[] chars, int start, int length)
org.xml.sax.ext.LexicalHandler
This callback will be used for comments inside or outside the document element, including comments in the external DTD subset (if read). Comments in the DTD must be properly nested inside start/endDTD and start/endEntity events (if used).
comment
in interface org.xml.sax.ext.LexicalHandler
comment
in class BaseMarkupSerializer
chars
- An array holding the characters in the comment.start
- The starting position in the array.length
- The number of characters to use from the array.public void characters(char[] chars, int start, int length) throws org.xml.sax.SAXException
org.xml.sax.ContentHandler
The Parser will call this method to report each chunk of character data. SAX parsers may return all contiguous character data in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity so that the Locator provides useful information.
The application must not attempt to read from the array outside of the specified range.
Individual characters may consist of more than one Java
char
value. There are two important cases where this
happens, because characters can't be represented in just sixteen bits.
In one case, characters are represented in a Surrogate Pair,
using two special Unicode values. Such characters are in the so-called
"Astral Planes", with a code point above U+FFFF. A second case involves
composite characters, such as a base character combining with one or
more accent characters.
Your code should not assume that algorithms using
char
-at-a-time idioms will be working in character
units; in some cases they will split characters. This is relevant
wherever XML permits arbitrary characters, such as attribute values,
processing instruction data, and comments as well as in data reported
from this method. It's also generally relevant whenever Java code
manipulates internationalized text; the issue isn't unique to XML.
Note that some parsers will report whitespace in element
content using the ignorableWhitespace
method rather than this one (validating parsers must
do so).
characters
in interface org.xml.sax.ContentHandler
characters
in interface org.xml.sax.DocumentHandler
characters
in class BaseMarkupSerializer
chars
- the characters from the XML documentstart
- the start position in the arraylength
- the number of characters to read from the arrayorg.xml.sax.SAXException
- Any SAX exception, possibly
wrapping another exception.ContentHandler.ignorableWhitespace(char[], int, int)
,
Locator
protected void characters(java.lang.String text, boolean unescaped) throws java.io.IOException
java.io.IOException
protected void startDocument(java.lang.String rootTagName) throws java.io.IOException
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.
java.io.IOException
protected void serializeElement(org.w3c.dom.Element elem) throws java.io.IOException
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.serializeElement
in class BaseMarkupSerializer
elem
- The element to serializejava.io.IOException
- An I/O exception occured while
serializingprotected void serializeNode(org.w3c.dom.Node node) throws java.io.IOException
serializeNode
in class BaseMarkupSerializer
node
- The node to serializejava.io.IOException
- An I/O exception occured while
serializingBaseMarkupSerializer.serializeElement(org.w3c.dom.Element)
protected ElementState content()
BaseMarkupSerializer
content
in class BaseMarkupSerializer
protected java.lang.String getEntityRef(int ch)
BaseMarkupSerializer
getEntityRef
in class BaseMarkupSerializer
ch
- Character valueCopyright © 1999-2022 The Apache Software Foundation. All Rights Reserved.