|
Oracle Fusion Middleware Oracle WebLogic Server API Reference 11g Release 1 (10.3.5) Part Number E13941-05 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectweblogic.apache.xml.serialize.BaseMarkupSerializer
weblogic.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
DOMWriter
and
serializing with DOMWriter
,
DOMWriter
.
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
Deprecated. |
protected boolean |
fDOML1
Deprecated. |
protected weblogic.apache.xerces.util.NamespaceSupport |
fLocalNSBinder
Deprecated. stores all namespace bindings on the current element |
protected int |
fNamespaceCounter
Deprecated. |
protected boolean |
fNamespaces
Deprecated. Controls whether namespace fixup should be performed during the serialization. |
protected weblogic.apache.xerces.util.NamespaceSupport |
fNSBinder
Deprecated. stores namespaces in scope |
protected weblogic.apache.xerces.util.SymbolTable |
fSymbolTable
Deprecated. symbol table for serialization |
protected static String |
PREFIX
Deprecated. |
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()
Deprecated. Constructs a new serializer. |
|
XMLSerializer(OutputFormat format)
Deprecated. Constructs a new serializer. |
|
XMLSerializer(OutputStream output,
OutputFormat format)
Deprecated. Constructs a new serializer that writes to the specified output stream using the specified output format. |
|
XMLSerializer(Writer writer,
OutputFormat format)
Deprecated. Constructs a new serializer that writes to the specified writer using the specified output format. |
Method Summary | |
---|---|
void |
endElement(String tagName)
Deprecated. |
void |
endElement(String namespaceURI,
String localName,
String rawName)
Deprecated. |
void |
endElementIO(String namespaceURI,
String localName,
String rawName)
Deprecated. |
protected String |
getEntityRef(int ch)
Deprecated. Returns the suitable entity reference for this character value, or null if no such entity exists. |
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. |
protected void |
printXMLChar(int ch)
Deprecated. |
boolean |
reset()
Deprecated. |
protected void |
serializeElement(Element elem)
Deprecated. Called to serialize a DOM element. |
void |
setNamespaces(boolean namespaces)
Deprecated. -- functionality could be removed |
void |
setOutputFormat(OutputFormat format)
Deprecated. Specifies an output format for this serializer. |
protected void |
startDocument(String rootTagName)
Deprecated. Called to serialize the document's DOCTYPE by the root element. |
void |
startElement(String tagName,
AttributeList attrs)
Deprecated. |
void |
startElement(String namespaceURI,
String localName,
String rawName,
Attributes attrs)
Deprecated. |
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 weblogic.apache.xerces.util.NamespaceSupport fNSBinder
protected weblogic.apache.xerces.util.NamespaceSupport fLocalNSBinder
protected weblogic.apache.xerces.util.SymbolTable fSymbolTable
protected boolean fDOML1
protected int fNamespaceCounter
protected static final 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(Writer writer, OutputFormat format)
writer
- The writer to useformat
- The output format to use, null for the defaultpublic XMLSerializer(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
- DOMWriter
public void startElement(String namespaceURI, String localName, String rawName, Attributes attrs) throws SAXException
SAXException
public void endElement(String namespaceURI, String localName, String rawName) throws SAXException
SAXException
public void endElementIO(String namespaceURI, String localName, String rawName) throws IOException
IOException
public void startElement(String tagName, AttributeList attrs) throws SAXException
SAXException
public void endElement(String tagName) throws SAXException
SAXException
protected void startDocument(String rootTagName) throws 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.
IOException
protected void serializeElement(Element elem) throws IOException
XMLSerializer.startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)
, XMLSerializer.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 serialize
IOException
- An I/O exception occured while
serializingprotected String getEntityRef(int ch)
BaseMarkupSerializer
getEntityRef
in class BaseMarkupSerializer
ch
- Character value
protected void printEscaped(String source) throws IOException
BaseMarkupSerializer
printEscaped
in class BaseMarkupSerializer
source
- The string to escape
IOException
protected final void printXMLChar(int ch) throws IOException
IOException
protected void printText(String text, boolean preserveSpace, boolean unescaped) throws IOException
printText
in class BaseMarkupSerializer
IOException
protected void printText(char[] chars, int start, int length, boolean preserveSpace, boolean unescaped) throws IOException
BaseMarkupSerializer
BaseMarkupSerializer.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.
printText
in class BaseMarkupSerializer
preserveSpace
- Space preserving flagunescaped
- Print unescaped
IOException
public boolean reset()
reset
in class BaseMarkupSerializer
|
Copyright 1996, 2011, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. Oracle Fusion Middleware Oracle WebLogic Server API Reference 11g Release 1 (10.3.5) Part Number E13941-05 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |