|
BEA Systems, Inc. | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--weblogic.apache.xml.serialize.BaseMarkupSerializer | +--weblogic.apache.xml.serialize.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
DOMWriter
and
serializing with DOMWriter.writeNode(java.io.OutputStream, org.w3c.dom.Node)
,
DOMWriter.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
Field Summary | |
protected static boolean |
DEBUG
|
protected boolean |
fDOML1
|
protected NamespaceSupport |
fLocalNSBinder
stores all namespace bindings on the current element |
protected int |
fNamespaceCounter
|
protected boolean |
fNamespaces
Controls whether namespace fixup should be performed during the serialization. |
protected NamespaceSupport |
fNSBinder
stores namespaces in scope |
protected SymbolTable |
fSymbolTable
symbol table for serialization |
protected static java.lang.String |
PREFIX
|
Fields inherited from class weblogic.apache.xml.serialize.BaseMarkupSerializer |
_docTypePublicId,
_docTypeSystemId,
_encodingInfo,
_format,
_indenting,
_prefixes,
_printer,
_started,
fDOMError,
fDOMErrorHandler,
fDOMFilter,
fFeatures,
fStrBuffer |
Constructor Summary | |
XMLSerializer()
Constructs a new serializer. |
|
XMLSerializer(OutputFormat format)
Constructs a new serializer. |
|
XMLSerializer(java.io.OutputStream output,
OutputFormat format)
Constructs a new serializer that writes to the specified output stream using the specified output format. |
|
XMLSerializer(java.io.Writer writer,
OutputFormat format)
Constructs a new serializer that writes to the specified writer using the specified output format. |
Method Summary | |
void |
endElement(java.lang.String tagName)
|
void |
endElement(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String rawName)
|
void |
endElementIO(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String rawName)
|
protected java.lang.String |
getEntityRef(int ch)
|
protected void |
printEscaped(java.lang.String source)
|
protected void |
printText(char[] chars,
int start,
int length,
boolean preserveSpace,
boolean unescaped)
|
protected void |
printText(java.lang.String text,
boolean preserveSpace,
boolean unescaped)
|
protected void |
printXMLChar(int ch)
|
boolean |
reset()
|
protected void |
serializeElement(org.w3c.dom.Element elem)
Called to serialize a DOM element. |
void |
setNamespaces(boolean namespaces)
Deprecated. -- functionality could be removed |
void |
setOutputFormat(OutputFormat format)
|
protected void |
startDocument(java.lang.String rootTagName)
Called to serialize the document's DOCTYPE by the root element. |
void |
startElement(java.lang.String tagName,
org.xml.sax.AttributeList attrs)
|
void |
startElement(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String rawName,
org.xml.sax.Attributes attrs)
|
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Field Detail |
protected static final boolean DEBUG
protected NamespaceSupport fNSBinder
protected NamespaceSupport fLocalNSBinder
protected SymbolTable fSymbolTable
protected boolean fDOML1
protected int fNamespaceCounter
protected static final java.lang.String PREFIX
protected boolean fNamespaces
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)
public void setNamespaces(boolean namespaces)
namespaces
- DOMWriter
public void startElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String rawName, org.xml.sax.Attributes attrs) throws org.xml.sax.SAXException
public void endElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String rawName) throws org.xml.sax.SAXException
public void endElementIO(java.lang.String namespaceURI, java.lang.String localName, java.lang.String rawName) throws java.io.IOException
public void startElement(java.lang.String tagName, org.xml.sax.AttributeList attrs) throws org.xml.sax.SAXException
public void endElement(java.lang.String tagName) throws org.xml.sax.SAXException
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.
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.
protected java.lang.String getEntityRef(int ch)
protected void printEscaped(java.lang.String source) throws java.io.IOException
protected final void printXMLChar(int ch) throws java.io.IOException
protected void printText(java.lang.String text, boolean preserveSpace, boolean unescaped) throws java.io.IOException
protected void printText(char[] chars, int start, int length, boolean preserveSpace, boolean unescaped) throws java.io.IOException
public boolean reset()
|
Documentation is available at http://download.oracle.com/docs/cd/E13222_01/wls/docs81 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |