OMDocumentImpl (Axiom Impl API)

java.lang.Object
- org.apache.axiom.om.impl.common.InformationItem
- - org.apache.axiom.om.impl.llom.OMInformationItemImpl
  - - org.apache.axiom.om.impl.llom.OMSerializableImpl
    - - org.apache.axiom.om.impl.llom.OMDocumentImpl

All Implemented Interfaces:

org.apache.axiom.core.CoreDocument, org.apache.axiom.core.CoreNode, org.apache.axiom.core.CoreParentNode, org.apache.axiom.core.DeferringParentNode, org.apache.axiom.om.impl.common.AxiomContainer, org.apache.axiom.om.impl.common.AxiomDocument, org.apache.axiom.om.impl.common.AxiomInformationItem, org.apache.axiom.om.impl.common.AxiomSerializable, org.apache.axiom.om.impl.OMContainerEx, org.apache.axiom.om.OMContainer, org.apache.axiom.om.OMDocument, org.apache.axiom.om.OMInformationItem, org.apache.axiom.om.OMSerializable

Direct Known Subclasses:

SOAPMessageImpl
```
public class OMDocumentImpl
extends OMSerializableImpl
implements org.apache.axiom.om.impl.common.AxiomDocument
```
Class OMDocumentImpl

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`charSetEncoding` Field charSetEncoding Default : UTF-8
`protected String`	`isStandalone`
`protected String`	`xmlEncoding`
`protected String`	`xmlVersion` Field xmlVersion

Fields inherited from interface org.apache.axiom.om.OMDocument
XML_10, XML_11

Fields inherited from interface org.apache.axiom.core.CoreParentNode
COMPLETE, DISCARDED, INCOMPLETE

Constructor Summary

Constructors
Constructor and Description
`OMDocumentImpl(org.apache.axiom.om.OMFactory factory)` Create a `OMDocument` given the `OMFactory`
`OMDocumentImpl(org.apache.axiom.om.OMXMLParserWrapper parserWrapper, org.apache.axiom.om.OMFactory factory)` Create the `OMDocument` with the factory

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`build()`
`void`	`checkChild(org.apache.axiom.om.OMNode child)`
`protected void`	`checkDocumentElement(org.apache.axiom.om.OMElement element)`
`org.apache.axiom.om.OMInformationItem`	`clone(org.apache.axiom.om.OMCloneOptions options)`
`protected org.apache.axiom.om.OMDocument`	`createClone(org.apache.axiom.om.OMCloneOptions options)`
`String`	`getCharsetEncoding()`
`String`	`getXMLEncoding()`
`String`	`getXMLVersion()`
`void`	`internalSerialize(org.apache.axiom.om.impl.common.serializer.push.Serializer serializer, org.apache.axiom.om.OMOutputFormat format, boolean cache)`
`protected void`	`internalSerialize(org.apache.axiom.om.impl.common.serializer.push.Serializer serializer, org.apache.axiom.om.OMOutputFormat format, boolean cache, boolean includeXMLDeclaration)`
`String`	`isStandalone()`
`void`	`setCharsetEncoding(String charEncoding)`
`void`	`setComplete(boolean complete)`
`void`	`setOMDocumentElement(org.apache.axiom.om.OMElement documentElement)`
`void`	`setStandalone(String isStandalone)`
`void`	`setXMLEncoding(String encoding)`
`void`	`setXMLVersion(String xmlVersion)`

Methods inherited from class org.apache.axiom.om.impl.llom.OMSerializableImpl
getOMFactory

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.axiom.om.impl.common.AxiomDocument
getOMDocumentElement

Methods inherited from interface org.apache.axiom.om.impl.common.AxiomContainer
addChild, addChild, defaultBuild, discarded, getFirstChildWithName, getFirstOMChild, getFirstOMChildIfAvailable, getSAXResult, getSAXSource, getXMLStreamReader, getXMLStreamReader, getXMLStreamReader, getXMLStreamReaderWithoutCaching, isComplete, prepareNewChild, removeChildren, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume

Methods inherited from interface org.apache.axiom.om.OMContainer
getBuilder, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getDescendants

Methods inherited from interface org.apache.axiom.om.OMSerializable
close, serialize, serialize, serializeAndConsume

Methods inherited from interface org.apache.axiom.om.OMInformationItem
getOMFactory

Methods inherited from interface org.apache.axiom.om.impl.common.AxiomSerializable
close, getBuilder, serialize, serialize, serializeAndConsume

Methods inherited from interface org.apache.axiom.om.impl.common.AxiomInformationItem
coreGetNodeFactory

Methods inherited from interface org.apache.axiom.core.CoreNode
coreGetOwnerDocument, coreHasSameOwnerDocument, coreSetOwnerDocument

Methods inherited from interface org.apache.axiom.core.CoreDocument
coreGetDocumentElement, coreSetOwnerDocument

Methods inherited from interface org.apache.axiom.core.DeferringParentNode
coreSetBuilder, coreSetState, forceExpand, getBuilder, getState

Methods inherited from interface org.apache.axiom.core.CoreParentNode
buildNext, coreAppendChild, coreAppendChildren, coreGetFirstChild, coreGetFirstChildIfAvailable, coreGetLastChild, coreGetLastKnownChild, coreRemoveChildren

- Field Detail
  - charSetEncoding
```
protected String charSetEncoding
```
    Field charSetEncoding Default : UTF-8
  - xmlVersion
```
protected String xmlVersion
```
    Field xmlVersion
  - xmlEncoding
```
protected String xmlEncoding
```
  - isStandalone
```
protected String isStandalone
```
- Constructor Detail
  - OMDocumentImpl
```
public OMDocumentImpl(org.apache.axiom.om.OMFactory factory)
```
    Create a OMDocument given the OMFactory
    
    Parameters:
    factory - The OMFactory that created this instace
  - OMDocumentImpl
```
public OMDocumentImpl(org.apache.axiom.om.OMXMLParserWrapper parserWrapper,
              org.apache.axiom.om.OMFactory factory)
```
    Create the OMDocument with the factory
    
    Parameters:
    parserWrapper -
    factory -
- Method Detail
  - setOMDocumentElement
```
public void setOMDocumentElement(org.apache.axiom.om.OMElement documentElement)
```
    Specified by:
    
    setOMDocumentElement in interface org.apache.axiom.om.OMDocument
  - setComplete
```
public void setComplete(boolean complete)
```
    Specified by:
    
    setComplete in interface org.apache.axiom.om.impl.common.AxiomSerializable
    
    Specified by:
    
    setComplete in interface org.apache.axiom.om.impl.OMContainerEx
  - checkChild
```
public final void checkChild(org.apache.axiom.om.OMNode child)
```
    Specified by:
    
    checkChild in interface org.apache.axiom.om.impl.common.AxiomContainer
  - checkDocumentElement
```
protected void checkDocumentElement(org.apache.axiom.om.OMElement element)
```
  - getCharsetEncoding
```
public String getCharsetEncoding()
```
    Specified by:
    
    getCharsetEncoding in interface org.apache.axiom.om.OMDocument
  - setCharsetEncoding
```
public void setCharsetEncoding(String charEncoding)
```
    Specified by:
    
    setCharsetEncoding in interface org.apache.axiom.om.OMDocument
  - isStandalone
```
public String isStandalone()
```
    Specified by:
    
    isStandalone in interface org.apache.axiom.om.OMDocument
  - setStandalone
```
public void setStandalone(String isStandalone)
```
    Specified by:
    
    setStandalone in interface org.apache.axiom.om.OMDocument
  - getXMLVersion
```
public String getXMLVersion()
```
    Specified by:
    
    getXMLVersion in interface org.apache.axiom.om.OMDocument
  - setXMLVersion
```
public void setXMLVersion(String xmlVersion)
```
    Specified by:
    
    setXMLVersion in interface org.apache.axiom.om.OMDocument
  - getXMLEncoding
```
public String getXMLEncoding()
```
    Specified by:
    
    getXMLEncoding in interface org.apache.axiom.om.OMDocument
  - setXMLEncoding
```
public void setXMLEncoding(String encoding)
```
    Specified by:
    
    setXMLEncoding in interface org.apache.axiom.om.OMDocument
  - internalSerialize
```
public void internalSerialize(org.apache.axiom.om.impl.common.serializer.push.Serializer serializer,
                     org.apache.axiom.om.OMOutputFormat format,
                     boolean cache)
                       throws org.apache.axiom.om.impl.common.serializer.push.OutputException
```
    Specified by:
    
    internalSerialize in interface org.apache.axiom.om.impl.common.AxiomSerializable
    
    Throws:
    
    org.apache.axiom.om.impl.common.serializer.push.OutputException
  - internalSerialize
```
protected void internalSerialize(org.apache.axiom.om.impl.common.serializer.push.Serializer serializer,
                     org.apache.axiom.om.OMOutputFormat format,
                     boolean cache,
                     boolean includeXMLDeclaration)
                          throws org.apache.axiom.om.impl.common.serializer.push.OutputException
```
    Throws:
    
    org.apache.axiom.om.impl.common.serializer.push.OutputException
  - build
```
public void build()
```
    Specified by:
    
    build in interface org.apache.axiom.core.CoreParentNode
    
    Specified by:
    
    build in interface org.apache.axiom.om.OMSerializable
  - clone
```
public org.apache.axiom.om.OMInformationItem clone(org.apache.axiom.om.OMCloneOptions options)
```
    Specified by:
    
    clone in interface org.apache.axiom.om.OMInformationItem
  - createClone
```
protected org.apache.axiom.om.OMDocument createClone(org.apache.axiom.om.OMCloneOptions options)
```

Class OMDocumentImpl

Field Summary

Fields inherited from interface org.apache.axiom.om.OMDocument

Fields inherited from interface org.apache.axiom.core.CoreParentNode

Constructor Summary

Method Summary

Methods inherited from class org.apache.axiom.om.impl.llom.OMSerializableImpl

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.axiom.om.impl.common.AxiomDocument

Methods inherited from interface org.apache.axiom.om.impl.common.AxiomContainer

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

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

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

Methods inherited from interface org.apache.axiom.om.impl.common.AxiomSerializable

Methods inherited from interface org.apache.axiom.om.impl.common.AxiomInformationItem

Methods inherited from interface org.apache.axiom.core.CoreNode

Methods inherited from interface org.apache.axiom.core.CoreDocument

Methods inherited from interface org.apache.axiom.core.DeferringParentNode

Methods inherited from interface org.apache.axiom.core.CoreParentNode

Field Detail

charSetEncoding

xmlVersion

xmlEncoding

isStandalone

Constructor Detail

OMDocumentImpl

OMDocumentImpl

Method Detail

setOMDocumentElement

setComplete

checkChild

checkDocumentElement

getCharsetEncoding

setCharsetEncoding

isStandalone

setStandalone

getXMLVersion

setXMLVersion

getXMLEncoding

setXMLEncoding

internalSerialize

internalSerialize

build

clone

createClone