org.apache.axiom.om
Interface OMDocument

All Superinterfaces:

OMContainer

All Known Subinterfaces:

SOAPMessage

All Known Implementing Classes:

DocumentImpl, OMDocumentImpl, SOAPMessageImpl, SOAPMessageImpl

public interface OMDocument
extends OMContainer

Field Summary

static String	XML_10 Field XML_10 XML Version 1.0
static String	XML_11 Field XML_11 XML Version 1.1

Method Summary

String	getCharsetEncoding() Returns the character set encoding scheme.
OMElement	getOMDocumentElement() Returns the document element.
OMFactory	getOMFactory() Returns the OMFactory that created this object
String	getXMLVersion() Returns the XML version.
String	isStandalone() XML standalone value.
void	serialize(OutputStream output) Serializes the document with cache on.
void	serialize(OutputStream output, OMOutputFormat format) Builds the OM node/tree and then serializes the document.
void	serializeAndConsume(OutputStream output) Serializes the OMDocument.
void	serializeAndConsume(OutputStream output, OMOutputFormat format) Serializes the OMDocument.
void	setCharsetEncoding(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(String isStandalone)
void	setXMLVersion(String version) Sets the XML version.

Methods inherited from interface org.apache.axiom.om.OMContainer

addChild, buildNext, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getFirstChildWithName, getFirstOMChild, isComplete

Field Detail

XML_10

static final String XML_10

Field XML_10 XML Version 1.0

See Also:

Constant Field Values

XML_11

static final String XML_11

Field XML_11 XML Version 1.1

See Also:

Constant Field Values

Method Detail

getOMDocumentElement

OMElement getOMDocumentElement()

Returns the document element.

Returns:

Returns OMElement.

setOMDocumentElement

void setOMDocumentElement(OMElement rootElement)

Sets the document element of the XML document.

Parameters:

rootElement -

getXMLVersion

String getXMLVersion()

Returns the XML version.

Returns:

Returns String.

setXMLVersion

void setXMLVersion(String version)

Sets the XML version.

Parameters:

version -

See Also:

XML 1.0, XML 1.1

getCharsetEncoding

String getCharsetEncoding()

Returns the character set encoding scheme.

Returns:

Returns String.

setCharsetEncoding

void setCharsetEncoding(String charsetEncoding)

Sets the character set encoding scheme to be used.

Parameters:

charsetEncoding -

isStandalone

String isStandalone()

XML standalone value. This will be yes, no or null (if not available)

Returns:

Returns boolean.

setStandalone

void setStandalone(String isStandalone)

serializeAndConsume

void serializeAndConsume(OutputStream output,
                         OMOutputFormat format)
                         throws javax.xml.stream.XMLStreamException

Serializes the OMDocument.

Parameters:

output -

format -

Throws:

javax.xml.stream.XMLStreamException

serialize

void serialize(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

void serializeAndConsume(OutputStream output)
                         throws javax.xml.stream.XMLStreamException

Serializes the OMDocument.

Parameters:

output -

Throws:

javax.xml.stream.XMLStreamException

serialize

void serialize(OutputStream output)
               throws javax.xml.stream.XMLStreamException

Serializes the document with cache on.

Parameters:

output -

Throws:

javax.xml.stream.XMLStreamException

getOMFactory

OMFactory getOMFactory()

Returns the OMFactory that created this object