|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Represents a holder of XML that can return an XmlCursor
or copy itself to various media such as
Writers
or Files
.
Both XmlObject
(and thus all XML Beans) and XmlCursor
are
XmlTokenSource implementations.
XmlObject
,
XmlCursor
Method Summary | |
XmlDocumentProperties |
documentProperties()
Returns the XmlDocumentProperties object for the document this token source is associated with. |
Object |
monitor()
Returns the synchronization object for the document. |
XmlCursor |
newCursor()
Returns a new XML cursor. |
Node |
newDomNode()
Returns a W3C DOM Node containing the XML represented by this source. |
Node |
newDomNode(XmlOptions options)
Just like newDomNode() but with options. |
InputStream |
newInputStream()
Returns a new stream containing standard XML text, encoded according to the given encoding. |
InputStream |
newInputStream(XmlOptions options)
Just like newInputStream(String encoding) but with options. |
Reader |
newReader()
Returns a new character reader containing XML text. |
Reader |
newReader(XmlOptions options)
Just like newReader() but with options. |
org.apache.xmlbeans.xml.stream.XMLInputStream |
newXMLInputStream()
Deprecated. Superceded by JSR 173 |
org.apache.xmlbeans.xml.stream.XMLInputStream |
newXMLInputStream(XmlOptions options)
Deprecated. Superceded by JSR 173 |
void |
save(ContentHandler ch,
LexicalHandler lh)
Writes the XML represented by this source to the given SAX content and lexical handlers. |
void |
save(ContentHandler ch,
LexicalHandler lh,
XmlOptions options)
Writes the XML represented by this source to the given SAX content and lexical handlers. |
void |
save(File file)
Writes the XML represented by this source to the given File. |
void |
save(File file,
XmlOptions options)
Writes the XML represented by this source to the given File. |
void |
save(OutputStream os)
Writes the XML represented by this source to the given output stream. |
void |
save(OutputStream os,
XmlOptions options)
Writes the XML represented by this source to the given output stream. |
void |
save(Writer w)
Writes the XML represented by this source to the given writer. |
void |
save(Writer w,
XmlOptions options)
Writes the XML represented by this source to the given writer. |
String |
xmlText()
Returns standard XML text. |
String |
xmlText(XmlOptions options)
Just like xmlText() but with options. |
Method Detail |
public Object monitor()
public XmlDocumentProperties documentProperties()
public XmlCursor newCursor()
public org.apache.xmlbeans.xml.stream.XMLInputStream newXMLInputStream()
public String xmlText()
public InputStream newInputStream()
public Reader newReader()
public Node newDomNode()
public void save(ContentHandler ch, LexicalHandler lh) throws SAXException
SAXException
public void save(File file) throws IOException
IOException
public void save(OutputStream os) throws IOException
IOException
public void save(Writer w) throws IOException
IOException
public org.apache.xmlbeans.xml.stream.XMLInputStream newXMLInputStream(XmlOptions options)
Just like newXMLInputStream() but with any of a number of options. Use the options parameter to specify the following:
To specify this | Use this method |
---|---|
The character encoding to use when converting the character data in the XML to bytess. | XmlOptions.setCharacterEncoding(java.lang.String) |
Prefix-to-namespace mappings that should be assumed when saving this XML. This is useful when the resulting XML will be part of a larger XML document, ensuring that this inner document will take advantage of namespaces defined in the outer document. | XmlOptions.setSaveImplicitNamespaces(java.util.Map) |
Suggested namespace prefixes to use when saving. Used only when a namespace attribute needs to be synthesized. | XmlOptions.setSaveSuggestedPrefixes(java.util.Map) |
That namespace attributes should occur first in elements when the XML is saved. By default, they occur last. | XmlOptions.setSaveNamespacesFirst() |
The XML should be pretty printed when saved. Note that this should only be used for debugging. | XmlOptions.setSavePrettyPrint() |
The number of spaces to use when indenting for pretty printing. The default is 2. | XmlOptions.setSavePrettyPrintIndent(int) |
The additional number of spaces indented from the left for pretty printed XML. | XmlOptions.setSavePrettyPrintOffset(int) |
To minimize the number of namespace attributes generated for the saved XML. Note that this can reduce performance significantly. | XmlOptions.setSaveAggresiveNamespaces() |
To reduce the size of the saved document by allowing the use of the default namespace. Note that this can potentially change the semantic meaning of the XML if unprefixed QNames are present as the value of an attribute or element. | XmlOptions.setUseDefaultNamespace() |
To filter out processing instructions with the specified target name. | XmlOptions.setSaveFilterProcinst(java.lang.String) |
Change the QName of the synthesized root element when saving. This replaces "xml-fragment" with "fragment" in the namespace http://www.openuri.org/fragment | XmlOptions.setSaveUseOpenFrag() |
Saving should begin on the element's contents. | XmlOptions.setSaveInner() |
Saving should begin on the element, rather than its contents. | XmlOptions.setSaveOuter() |
To rename the document element, or to specify the document element for this XML. | XmlOptions.setSaveSyntheticDocumentElement(javax.xml.namespace.QName) |
options
- Any of the described options.
XmlOptions
public String xmlText(XmlOptions options)
XmlOptions
public InputStream newInputStream(XmlOptions options)
XmlOptions
public Reader newReader(XmlOptions options)
XmlOptions
public Node newDomNode(XmlOptions options)
XmlOptions
public void save(ContentHandler ch, LexicalHandler lh, XmlOptions options) throws SAXException
SAXException
public void save(File file, XmlOptions options) throws IOException
IOException
public void save(OutputStream os, XmlOptions options) throws IOException
IOException
public void save(Writer w, XmlOptions options) throws IOException
IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |