org.apache.axis2.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 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 caracter set encoding scheme
OMElement	getOMDocumentElement() Returns the document element
java.lang.String	getXMLVersion() Returns the XML version
java.lang.String	isStandalone() XML standalone value This will be yes, no or null (if not available)
void	serialize(java.io.OutputStream output) Serializa the document with cache on
void	serialize(java.io.OutputStream output, OMOutputFormat format) Serializa the document with cache on
void	serializeAndConsume(java.io.OutputStream output) Serialize the OMDocument
void	serializeAndConsume(java.io.OutputStream output, OMOutputFormat format) Serialize 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.axis2.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:

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:

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 caracter set encoding scheme

Returns:

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:

boolean

setStandalone

public void setStandalone(java.lang.String isStandalone)

serializeAndConsume

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

Serialize 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

Serializa the document with cache on

Parameters:

output -

format -

Throws:

javax.xml.stream.XMLStreamException

serializeAndConsume

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

Serialize the OMDocument

Parameters:

output -

Throws:

javax.xml.stream.XMLStreamException

serialize

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

Serializa the document with cache on

Parameters:

output -

Throws:

javax.xml.stream.XMLStreamException