OMElementImpl (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.OMNodeImpl
      - org.apache.axiom.om.impl.llom.OMElementImpl

All Implemented Interfaces:

org.apache.axiom.core.CoreChildNode, org.apache.axiom.core.CoreElement, org.apache.axiom.core.CoreNode, org.apache.axiom.core.CoreParentNode, org.apache.axiom.core.DeferringParentNode, org.apache.axiom.om.impl.common.AxiomChildNode, org.apache.axiom.om.impl.common.AxiomContainer, org.apache.axiom.om.impl.common.AxiomElement, org.apache.axiom.om.impl.common.AxiomInformationItem, org.apache.axiom.om.impl.common.AxiomNamedInformationItem, org.apache.axiom.om.impl.common.AxiomSerializable, org.apache.axiom.om.impl.OMContainerEx, org.apache.axiom.om.impl.OMElementEx, org.apache.axiom.om.impl.OMNodeEx, org.apache.axiom.om.OMConstants, org.apache.axiom.om.OMContainer, org.apache.axiom.om.OMElement, org.apache.axiom.om.OMInformationItem, org.apache.axiom.om.OMNamedInformationItem, org.apache.axiom.om.OMNode, org.apache.axiom.om.OMSerializable

Direct Known Subclasses:

OMSourcedElementImpl, SOAPElement
```
public class OMElementImpl
extends OMNodeImpl
implements org.apache.axiom.om.impl.common.AxiomElement, org.apache.axiom.om.OMConstants
```
Class OMElementImpl

Field Summary

Fields
Modifier and Type Field and Description

protected HashMap attributes
Field attributes

protected HashMap namespaces
Field namespaces
- Fields inherited from interface org.apache.axiom.om.OMNode
  CDATA_SECTION_NODE, COMMENT_NODE, DTD_NODE, ELEMENT_NODE, ENTITY_REFERENCE_NODE, PI_NODE, SPACE_NODE, TEXT_NODE
- Fields inherited from interface org.apache.axiom.core.CoreParentNode
  COMPLETE, DISCARDED, INCOMPLETE
- Fields inherited from interface org.apache.axiom.om.OMConstants
  ARRAY_ITEM_LOCALNAME, ARRAY_ITEM_NS_PREFIX, ARRAY_ITEM_NSURI, ARRAY_ITEM_QNAME, DATA_HANDLER, DEFAULT_CHAR_SET_ENCODING, DEFAULT_DEFAULT_NAMESPACE, DEFAULT_XML_VERSION, IS_BINARY, IS_DATA_HANDLERS_AWARE, PULL_TYPE_BUILDER, PUSH_TYPE_BUILDER, XMLATTRTYPE_CDATA, XMLATTRTYPE_ENTITIES, XMLATTRTYPE_ENTITY, XMLATTRTYPE_ID, XMLATTRTYPE_IDREF, XMLATTRTYPE_IDREFS, XMLATTRTYPE_NMTOKEN, XMLATTRTYPE_NMTOKENS, XMLATTRTYPE_NOTATION, XMLNS_NS_PREFIX, XMLNS_NS_URI, XMLNS_PREFIX, XMLNS_URI

Fields
Modifier and Type	Field and Description
`protected HashMap`	`attributes` Field attributes
`protected HashMap`	`namespaces` Field namespaces

Constructor Summary

Constructors
Constructor and Description
`OMElementImpl(org.apache.axiom.om.OMContainer parent, String localName, org.apache.axiom.om.OMNamespace ns, org.apache.axiom.om.OMXMLParserWrapper builder, org.apache.axiom.om.OMFactory factory, boolean generateNSDecl)`
`OMElementImpl(QName qname, org.apache.axiom.om.OMContainer parent, org.apache.axiom.om.OMFactory factory)` It is assumed that the QName passed contains, at least, the localName for this element.

Method Summary

Methods
Modifier and Type	Method and Description
`org.apache.axiom.om.OMAttribute`	`addAttribute(org.apache.axiom.om.OMAttribute attr)` Inserts an attribute to this element.
`org.apache.axiom.om.OMAttribute`	`addAttribute(String localName, String value, org.apache.axiom.om.OMNamespace ns)`
`void`	`addNamespaceDeclaration(org.apache.axiom.om.OMNamespace ns)`
`org.apache.axiom.om.OMNamespace`	`addNamespaceDeclaration(String uri, String prefix)`
`void`	`build()`
`void`	`buildWithAttachments()`
`void`	`checkChild(org.apache.axiom.om.OMNode child)`
`org.apache.axiom.om.OMElement`	`cloneOMElement()`
`protected org.apache.axiom.om.OMElement`	`createClone(org.apache.axiom.om.OMCloneOptions options, org.apache.axiom.om.OMContainer targetParent)`
`org.apache.axiom.om.OMNamespace`	`declareDefaultNamespace(String uri)`
`org.apache.axiom.om.OMNamespace`	`declareNamespace(org.apache.axiom.om.OMNamespace namespace)`
`org.apache.axiom.om.OMNamespace`	`declareNamespace(String uri, String prefix)`
`org.apache.axiom.om.OMNamespace`	`findNamespace(String uri, String prefix)` Finds a namespace with the given uri and prefix, in the scope of the document.
`org.apache.axiom.om.OMNamespace`	`findNamespaceURI(String prefix)`
`Iterator`	`getAllAttributes()` Returns a List of OMAttributes.
`Iterator`	`getAllDeclaredNamespaces()` Method getAllDeclaredNamespaces.
`org.apache.axiom.om.OMAttribute`	`getAttribute(QName qname)` Returns a named attribute if present.
`String`	`getAttributeValue(QName qname)` Returns a named attribute's value, if present.
`org.apache.axiom.om.OMNamespace`	`getDefaultNamespace()`
`int`	`getLineNumber()`
`String`	`getNamespaceURI()`
`void`	`internalSerialize(org.apache.axiom.om.impl.common.serializer.push.Serializer serializer, org.apache.axiom.om.OMOutputFormat format, boolean cache)`
`void`	`removeAttribute(org.apache.axiom.om.OMAttribute attr)`
`void`	`setComplete(boolean complete)`
`void`	`setLineNumber(int lineNumber)`
`void`	`setNamespace(org.apache.axiom.om.OMNamespace namespace)`
`String`	`toString()`
`String`	`toStringWithConsume()`
`void`	`undeclarePrefix(String prefix)`

Methods inherited from class org.apache.axiom.om.impl.llom.OMNodeImpl
clone, coreSetParent

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, wait, wait, wait

Methods inherited from interface org.apache.axiom.om.impl.common.AxiomElement
detachAndDiscardParent, discard, getChildElements, getFirstElement, getNamespaceContext, getNamespacesInScope, getText, getTextAsQName, getTextAsStream, getType, handleNamespace, insertChild, resolveQName, setNamespace, setNamespaceWithNoFindInCurrentScope, setText, setText, writeTextTo

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

Methods inherited from interface org.apache.axiom.om.OMNamedInformationItem
getLocalName, getNamespace, getPrefix, getQName, hasName, setLocalName

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.impl.common.AxiomChildNode
detach, getNextOMSibling, getNextOMSiblingIfAvailable, getParent, getPreviousOMSibling, insertSiblingAfter, insertSiblingBefore

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.om.impl.common.AxiomNamedInformationItem
getLocalName, getNamespace, getPrefix, getQName, handleNamespace, hasName, internalGetLocalName, internalSetLocalName, internalSetNamespace, setLocalName

Methods inherited from interface org.apache.axiom.core.CoreChildNode
coreDetach, coreGetNextSibling, coreGetNextSiblingIfAvailable, coreGetParent, coreGetPreviousSibling, coreHasParent, coreInsertSiblingAfter, coreInsertSiblingBefore, coreInsertSiblingsBefore, coreSetNextSibling, coreSetOwnerDocument, coreSetPreviousSibling, internalSetParent, internalUnsetParent

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
  - namespaces
```
protected HashMap namespaces
```
    Field namespaces
  - attributes
```
protected HashMap attributes
```
    Field attributes
- Constructor Detail
  - OMElementImpl
```
public OMElementImpl(org.apache.axiom.om.OMContainer parent,
             String localName,
             org.apache.axiom.om.OMNamespace ns,
             org.apache.axiom.om.OMXMLParserWrapper builder,
             org.apache.axiom.om.OMFactory factory,
             boolean generateNSDecl)
```
  - OMElementImpl
```
public OMElementImpl(QName qname,
             org.apache.axiom.om.OMContainer parent,
             org.apache.axiom.om.OMFactory factory)
              throws org.apache.axiom.om.OMException
```
    It is assumed that the QName passed contains, at least, the localName for this element.
    
    Parameters:
    qname - - this should be valid qname according to javax.xml.namespace.QName
    
    Throws:
    
    org.apache.axiom.om.OMException
- Method Detail
  - checkChild
```
public void checkChild(org.apache.axiom.om.OMNode child)
```
    Specified by:
    
    checkChild in interface org.apache.axiom.om.impl.common.AxiomContainer
  - declareNamespace
```
public org.apache.axiom.om.OMNamespace declareNamespace(String uri,
                                               String prefix)
```
    Specified by:
    
    declareNamespace in interface org.apache.axiom.om.OMElement
  - declareDefaultNamespace
```
public org.apache.axiom.om.OMNamespace declareDefaultNamespace(String uri)
```
    Specified by:
    
    declareDefaultNamespace in interface org.apache.axiom.om.OMElement
  - getDefaultNamespace
```
public org.apache.axiom.om.OMNamespace getDefaultNamespace()
```
    Specified by:
    
    getDefaultNamespace in interface org.apache.axiom.om.OMElement
  - addNamespaceDeclaration
```
public org.apache.axiom.om.OMNamespace addNamespaceDeclaration(String uri,
                                                      String prefix)
```
    Specified by:
    
    addNamespaceDeclaration in interface org.apache.axiom.om.impl.OMElementEx
  - addNamespaceDeclaration
```
public void addNamespaceDeclaration(org.apache.axiom.om.OMNamespace ns)
```
    Specified by:
    
    addNamespaceDeclaration in interface org.apache.axiom.om.impl.common.AxiomElement
  - declareNamespace
```
public org.apache.axiom.om.OMNamespace declareNamespace(org.apache.axiom.om.OMNamespace namespace)
```
    Specified by:
    
    declareNamespace in interface org.apache.axiom.om.OMElement
    
    Returns:
    Returns namespace.
  - undeclarePrefix
```
public void undeclarePrefix(String prefix)
```
    Specified by:
    
    undeclarePrefix in interface org.apache.axiom.om.OMElement
  - findNamespace
```
public org.apache.axiom.om.OMNamespace findNamespace(String uri,
                                            String prefix)
```
    Finds a namespace with the given uri and prefix, in the scope of the document. Starts to find from the current element and goes up in the hiararchy until one is found. If none is found, returns null.
    
    Specified by:
    
    findNamespace in interface org.apache.axiom.om.OMElement
  - findNamespaceURI
```
public org.apache.axiom.om.OMNamespace findNamespaceURI(String prefix)
```
    Specified by:
    
    findNamespaceURI in interface org.apache.axiom.om.OMElement
  - getAllDeclaredNamespaces
```
public Iterator getAllDeclaredNamespaces()
```
    Method getAllDeclaredNamespaces.
    
    Specified by:
    
    getAllDeclaredNamespaces in interface org.apache.axiom.om.OMElement
    
    Returns:
    Returns Iterator.
  - getAllAttributes
```
public Iterator getAllAttributes()
```
    Returns a List of OMAttributes.
    
    Specified by:
    
    getAllAttributes in interface org.apache.axiom.om.OMElement
    
    Returns:
    Returns iterator.
  - getAttribute
```
public org.apache.axiom.om.OMAttribute getAttribute(QName qname)
```
    Returns a named attribute if present.
    
    Specified by:
    
    getAttribute in interface org.apache.axiom.om.OMElement
    
    Parameters:
    qname - the qualified name to search for
    
    Returns:
    Returns an OMAttribute with the given name if found, or null
  - getAttributeValue
```
public String getAttributeValue(QName qname)
```
    Returns a named attribute's value, if present.
    
    Specified by:
    
    getAttributeValue in interface org.apache.axiom.om.OMElement
    
    Parameters:
    qname - the qualified name to search for
    
    Returns:
    Returns a String containing the attribute value, or null.
  - addAttribute
```
public org.apache.axiom.om.OMAttribute addAttribute(org.apache.axiom.om.OMAttribute attr)
```
    Inserts an attribute to this element. Implementor can decide as to insert this in the front or at the end of set of attributes.
    The owner of the attribute is set to be the particular OMElement. If the attribute already has an owner then the attribute is cloned (i.e. its name, value and namespace are copied to a new attribute) and the new attribute is added to the element. It's owner is then set to be the particular OMElement.
    
    Specified by:
    
    addAttribute in interface org.apache.axiom.om.OMElement
    
    Returns:
    The attribute that was added to the element. Note: The added attribute may not be the same instance that was given to add. This can happen if the given attribute already has an owner. In such case the returned attribute and the given attribute are equal but not the same instance.
    See Also:
    OMAttributeImpl.equals(Object)
  - removeAttribute
```
public void removeAttribute(org.apache.axiom.om.OMAttribute attr)
```
    Specified by:
    
    removeAttribute in interface org.apache.axiom.om.OMElement
  - addAttribute
```
public org.apache.axiom.om.OMAttribute addAttribute(String localName,
                                           String value,
                                           org.apache.axiom.om.OMNamespace ns)
```
    Specified by:
    
    addAttribute in interface org.apache.axiom.om.OMElement
  - build
```
public void build()
           throws org.apache.axiom.om.OMException
```
    Specified by:
    
    build in interface org.apache.axiom.core.CoreParentNode
    
    Specified by:
    
    build in interface org.apache.axiom.om.OMSerializable
    
    Throws:
    
    org.apache.axiom.om.OMException
  - 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
    
    Specified by:
    
    setComplete in interface org.apache.axiom.om.impl.OMNodeEx
  - 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
  - getNamespaceURI
```
public String getNamespaceURI()
```
    Specified by:
    
    getNamespaceURI in interface org.apache.axiom.om.OMNamedInformationItem
  - setNamespace
```
public void setNamespace(org.apache.axiom.om.OMNamespace namespace)
```
    Specified by:
    
    setNamespace in interface org.apache.axiom.om.OMElement
  - toStringWithConsume
```
public String toStringWithConsume()
                           throws javax.xml.stream.XMLStreamException
```
    Specified by:
    
    toStringWithConsume in interface org.apache.axiom.om.OMElement
    
    Throws:
    
    javax.xml.stream.XMLStreamException
  - toString
```
public String toString()
```
    Specified by:
    
    toString in interface org.apache.axiom.om.OMElement
    
    Overrides:
    
    toString in class Object
  - cloneOMElement
```
public org.apache.axiom.om.OMElement cloneOMElement()
```
    Specified by:
    
    cloneOMElement in interface org.apache.axiom.om.OMElement
  - createClone
```
protected org.apache.axiom.om.OMElement createClone(org.apache.axiom.om.OMCloneOptions options,
                                        org.apache.axiom.om.OMContainer targetParent)
```
  - setLineNumber
```
public void setLineNumber(int lineNumber)
```
    Specified by:
    
    setLineNumber in interface org.apache.axiom.om.OMElement
  - getLineNumber
```
public int getLineNumber()
```
    Specified by:
    
    getLineNumber in interface org.apache.axiom.om.OMElement
  - buildWithAttachments
```
public void buildWithAttachments()
```
    Specified by:
    
    buildWithAttachments in interface org.apache.axiom.om.impl.common.AxiomChildNode
    
    Specified by:
    
    buildWithAttachments in interface org.apache.axiom.om.OMNode

Class OMElementImpl

Field Summary

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

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

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

Constructor Summary

Method Summary

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

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.AxiomElement

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

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

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.impl.common.AxiomChildNode

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.om.impl.common.AxiomNamedInformationItem

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

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

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

Field Detail

namespaces

attributes

Constructor Detail

OMElementImpl

OMElementImpl

Method Detail

checkChild

declareNamespace

declareDefaultNamespace

getDefaultNamespace

addNamespaceDeclaration

addNamespaceDeclaration

declareNamespace

undeclarePrefix

findNamespace

findNamespaceURI

getAllDeclaredNamespaces

getAllAttributes

getAttribute

getAttributeValue

addAttribute

removeAttribute

addAttribute

build

setComplete

internalSerialize

getNamespaceURI

setNamespace

toStringWithConsume

toString

cloneOMElement

createClone

setLineNumber

getLineNumber

buildWithAttachments