org.apache.axiom.om
Interface OMDocument

All Superinterfaces:
OMContainer
All Known Subinterfaces:
SOAPMessage

public interface OMDocument
extends OMContainer


Field Summary
static java.lang.String XML_10
          Field XML_10 XML Version 1.0
static java.lang.String XML_11
          Field XML_11 XML Version 1.1
 
Method Summary
 java.lang.String getCharsetEncoding()
          Returns the character set encoding scheme.
 OMElement getOMDocumentElement()
          Returns the document element.
 OMFactory getOMFactory()
          Returns the OMFactory that created this object
 java.lang.String getXMLVersion()
          Returns the XML version.
 java.lang.String isStandalone()
          XML standalone value.
 void serialize(java.io.OutputStream output)
          Serializes the document with cache on.
 void serialize(java.io.OutputStream output, OMOutputFormat format)
          Builds the OM node/tree and then serializes the document.
 void serializeAndConsume(java.io.OutputStream output)
          Serializes the OMDocument.
 void serializeAndConsume(java.io.OutputStream output, OMOutputFormat format)
          Serializes the OMDocument.
 void setCharsetEncoding(java.lang.String charsetEncoding)
          Sets the character set encoding scheme to be used.
 void setOMDocumentElement(OMElement rootElement)
          Sets the document element of the XML document.
 void setStandalone(java.lang.String isStandalone)
           
 void setXMLVersion(java.lang.String version)
          Sets the XML version.
 
Methods inherited from interface org.apache.axiom.om.OMContainer
addChild, buildNext, getChildren, getChildrenWithName, getFirstChildWithName, getFirstOMChild, isComplete
 

Field Detail

XML_10

public static final java.lang.String XML_10
Field XML_10 XML Version 1.0

See Also:
Constant Field Values

XML_11

public static final java.lang.String XML_11
Field XML_11 XML Version 1.1

See Also:
Constant Field Values
Method Detail

getOMDocumentElement

public OMElement getOMDocumentElement()
Returns the document element.

Returns:
Returns OMElement.

setOMDocumentElement

public void setOMDocumentElement(OMElement rootElement)
Sets the document element of the XML document.

Parameters:
rootElement -

getXMLVersion

public java.lang.String getXMLVersion()
Returns the XML version.

Returns:
Returns String.

setXMLVersion

public void setXMLVersion(java.lang.String version)
Sets the XML version.

Parameters:
version -
See Also:
XML 1.0, XML 1.1

getCharsetEncoding

public java.lang.String getCharsetEncoding()
Returns the character set encoding scheme.

Returns:
Returns String.

setCharsetEncoding

public void setCharsetEncoding(java.lang.String charsetEncoding)
Sets the character set encoding scheme to be used.

Parameters:
charsetEncoding -

isStandalone

public java.lang.String isStandalone()
XML standalone value. This will be yes, no or null (if not available)

Returns:
Returns boolean.

setStandalone

public void setStandalone(java.lang.String isStandalone)

serializeAndConsume

public void serializeAndConsume(java.io.OutputStream output,
                                OMOutputFormat format)
                         throws javax.xml.stream.XMLStreamException
Serializes the OMDocument.

Parameters:
output -
format -
Throws:
javax.xml.stream.XMLStreamException

serialize

public void serialize(java.io.OutputStream output,
                      OMOutputFormat format)
               throws javax.xml.stream.XMLStreamException
Builds the OM node/tree and then serializes the document.

Parameters:
output -
format -
Throws:
javax.xml.stream.XMLStreamException

serializeAndConsume

public void serializeAndConsume(java.io.OutputStream output)
                         throws javax.xml.stream.XMLStreamException
Serializes the OMDocument.

Parameters:
output -
Throws:
javax.xml.stream.XMLStreamException

serialize

public void serialize(java.io.OutputStream output)
               throws javax.xml.stream.XMLStreamException
Serializes the document with cache on.

Parameters:
output -
Throws:
javax.xml.stream.XMLStreamException

getOMFactory

public OMFactory getOMFactory()
Returns the OMFactory that created this object



Copyright © 2004-2007 Apache Software Foundation. All Rights Reserved.