|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.xml.serialize.BaseMarkupSerializer org.apache.xml.serialize.XMLSerializer
public class XMLSerializer
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
LSSerializer
and
serializing with LSSerializer.write(org.w3c.dom.Node, org.w3c.dom.ls.LSOutput)
,
LSSerializer.writeToString(org.w3c.dom.Node)
.
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.
Serializer
Constructor Summary | |
---|---|
XMLSerializer()
Deprecated. Constructs a new serializer. |
|
XMLSerializer(OutputFormat format)
Deprecated. Constructs a new serializer. |
|
XMLSerializer(java.io.OutputStream output,
OutputFormat format)
Deprecated. Constructs a new serializer that writes to the specified output stream using the specified output format. |
|
XMLSerializer(java.io.Writer writer,
OutputFormat format)
Deprecated. Constructs a new serializer that writes to the specified writer using the specified output format. |
Method Summary | |
---|---|
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 namespaceURI,
java.lang.String localName,
java.lang.String rawName)
Deprecated. |
boolean |
reset()
Deprecated. |
void |
setNamespaces(boolean namespaces)
Deprecated. This methods turns on namespace fixup algorithm during DOM serialization. |
void |
setOutputFormat(OutputFormat format)
Deprecated. Specifies an output format for this serializer. |
void |
startElement(java.lang.String tagName,
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,
Attributes attrs)
Deprecated. Receive notification of the beginning of an element. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public XMLSerializer()
BaseMarkupSerializer.setOutputCharStream(java.io.Writer)
or BaseMarkupSerializer.setOutputByteStream(java.io.OutputStream)
first.
public XMLSerializer(OutputFormat format)
BaseMarkupSerializer.setOutputCharStream(java.io.Writer)
or BaseMarkupSerializer.setOutputByteStream(java.io.OutputStream)
first.
public XMLSerializer(java.io.Writer writer, OutputFormat format)
writer
- The writer to useformat
- The output format to use, null for the defaultpublic XMLSerializer(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)
Serializer
setOutputFormat
in interface Serializer
setOutputFormat
in class BaseMarkupSerializer
format
- The output format to usepublic void setNamespaces(boolean namespaces)
namespaces
- LSSerializer
public void startElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String rawName, Attributes attrs) throws SAXException
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 undefined
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 SAXException
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 available
SAXException
- any SAX exception, possibly
wrapping another exceptionpublic void endElementIO(java.lang.String namespaceURI, java.lang.String localName, java.lang.String rawName) throws java.io.IOException
java.io.IOException
public void startElement(java.lang.String tagName, AttributeList attrs) throws SAXException
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.
SAXException
- Any SAX exception, possibly
wrapping another exception.DocumentHandler.endElement(java.lang.String)
,
AttributeList
public void endElement(java.lang.String tagName) throws SAXException
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 name
SAXException
- Any SAX exception, possibly
wrapping another exception.public boolean reset()
reset
in class BaseMarkupSerializer
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |