|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.xml.serialize.BaseMarkupSerializer | +--org.apache.xml.serialize.TextSerializer
Implements a text serializer supporting both DOM and SAX
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()
.
Serializer
Fields inherited from class org.apache.xml.serialize.BaseMarkupSerializer |
_docTypePublicId,
_docTypeSystemId,
_exception,
_format,
_prefixes,
_started,
_writer |
Constructor Summary | |
TextSerializer()
Constructs a new serializer. |
|
TextSerializer(OutputFormat format)
Constructs a new serializer. |
|
TextSerializer(java.io.OutputStream output,
OutputFormat format)
Constructs a new serializer that writes to the specified output stream using the specified output format. |
|
TextSerializer(java.io.Writer writer,
OutputFormat format)
Constructs a new serializer that writes to the specified writer using the specified output format. |
Method Summary | |
void |
characters(char[] chars,
int start,
int length)
Receive notification of character data. |
protected void |
characters(java.lang.String text,
boolean unescaped)
Called to print the text contents in the prevailing element format. |
void |
comment(char[] chars,
int start,
int length)
Report an XML comment anywhere in the document. |
void |
comment(java.lang.String text)
|
protected org.apache.xml.serialize.ElementState |
content()
Must be called by a method about to print any type of content. |
void |
endElement(java.lang.String tagName)
Receive notification of the end of an element. |
void |
endElement(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String rawName)
Receive notification of the end of an element. |
protected java.lang.String |
getEntityRef(char ch)
Returns the suitable entity reference for this character value, or null if no such entity exists. |
void |
processingInstruction(java.lang.String target,
java.lang.String code)
Receive notification of a processing instruction. |
protected void |
serializeElement(Element elem)
Called to serialize a DOM element. |
protected void |
serializeNode(Node node)
Serialize the DOM node. |
void |
setOutputFormat(OutputFormat format)
Specifies an output format for this serializer. |
void |
startDocument()
Receive notification of the beginning of a document. |
protected void |
startDocument(java.lang.String rootTagName)
Called to serialize the document's DOCTYPE by the root element. |
void |
startElement(java.lang.String tagName,
AttributeList attrs)
Receive notification of the beginning of an element. |
void |
startElement(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String rawName,
Attributes attrs)
Receive notification of the beginning of an element. |
Methods inherited from class org.apache.xml.serialize.BaseMarkupSerializer |
asContentHandler,
asDocumentHandler,
asDOMSerializer,
attributeDecl,
breakLine,
breakLine,
elementDecl,
endCDATA,
endDocument,
endDTD,
endEntity,
endPrefixMapping,
enterDTD,
enterElementState,
escape,
externalEntityDecl,
flush,
getElementState,
getPrefix,
ignorableWhitespace,
indent,
internalEntityDecl,
leaveDTD,
leaveElementState,
notationDecl,
printDoctypeURL,
printSpace,
printText,
printText,
printText,
printText,
reset,
serialize,
serialize,
serialize,
serializePreRoot,
setDocumentLocator,
setOutputByteStream,
setOutputCharStream,
skippedEntity,
startCDATA,
startDTD,
startEntity,
startPrefixMapping,
unindent,
unparsedEntityDecl |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Constructor Detail |
public TextSerializer()
BaseMarkupSerializer.setOutputCharStream(java.io.Writer)
or BaseMarkupSerializer.setOutputByteStream(java.io.OutputStream)
first.public TextSerializer(OutputFormat format)
BaseMarkupSerializer.setOutputCharStream(java.io.Writer)
or BaseMarkupSerializer.setOutputByteStream(java.io.OutputStream)
first.public TextSerializer(java.io.Writer writer, OutputFormat format)
writer
- The writer to useformat
- The output format to use, null for the defaultpublic TextSerializer(java.io.OutputStream output, OutputFormat format)
output
- The output stream to useformat
- The output format to use, null for the defaultMethod Detail |
public void setOutputFormat(OutputFormat format)
format
- The output format to usepublic void startElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String rawName, Attributes attrs)
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/raw-names 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/raw-names property is true (it is false by default, and support for a true value is optional).
uri
- The Namespace URI, or the empty string if the
element has no Namespace URI or if Namespace
processing is not being performed.localName
- The local name (without prefix), or the
empty string if Namespace processing is not being
performed.rawName
- The raw XML 1.0 name (with prefix), or the
empty string if raw names are not available.atts
- The attributes attached to the element. If
there are no attributes, it shall be an empty
Attributes object.ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String)
,
Attributes
public void endElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String rawName)
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.
uri
- The Namespace URI, or the empty string if the
element has no Namespace URI or if Namespace
processing is not being performed.localName
- The local name (without prefix), or the
empty string if Namespace processing is not being
performed.rawName
- The raw XML 1.0 name (with prefix), or the
empty string if raw names are not available.public void startDocument()
The SAX parser will invoke this method only once, before any other methods in this interface or in DTDHandler (except for setDocumentLocator).
public void startElement(java.lang.String tagName, AttributeList attrs)
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.
name
- The element type name.atts
- The attributes attached to the element, if any.DocumentHandler.endElement(java.lang.String)
,
AttributeList
public void endElement(java.lang.String tagName)
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.
name
- The element type namepublic void processingInstruction(java.lang.String target, java.lang.String code)
The Parser will invoke this method once for each processing instruction found: note that processing instructions may occur before or after the main document element.
A SAX parser should never report an XML declaration (XML 1.0, section 2.8) or a text declaration (XML 1.0, section 4.3.1) using this method.
target
- The processing instruction target.data
- The processing instruction data, or null if
none was supplied.public void comment(java.lang.String text)
public void comment(char[] chars, int start, int length)
This callback will be used for comments inside or outside the document element, including comments in the external DTD subset (if read).
ch
- 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)
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.
Note that some parsers will report whitespace using the ignorableWhitespace() method rather than this one (validating parsers must do so).
ch
- The characters from the XML document.start
- The start position in the array.length
- The number of characters to read from the array.ContentHandler.ignorableWhitespace(char[], int, int)
,
Locator
protected void characters(java.lang.String text, boolean unescaped)
text
- The text to printunescaped
- True is should print unescapedprotected void startDocument(java.lang.String rootTagName)
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.
protected void serializeElement(Element elem)
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.elem
- The element to serializeprotected void serializeNode(Node node)
node
- The node to serializeprotected org.apache.xml.serialize.ElementState content()
protected java.lang.String getEntityRef(char ch)
ch
- Character value
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |