## Uses of Interface
org.apache.axiom.om.OMElement

- Packages that use OMElement
  Package | Description
  --- | ---
  org.apache.axiom.om | Contains core interfaces of the Axiom API.
  org.apache.axiom.om.ds.custombuilder |
  org.apache.axiom.om.impl |
  org.apache.axiom.om.impl.builder |
  org.apache.axiom.om.impl.util |
  org.apache.axiom.om.util |
  org.apache.axiom.om.util.jaxb |
  org.apache.axiom.om.xpath |
  org.apache.axiom.soap |
  org.apache.axiom.soap.impl.builder |

- - ### Uses of OMElement in org.apache.axiom.om

    Subinterfaces of OMElement in org.apache.axiom.om
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `OMSourcedElement` Element whose data is backed by an arbitrary Java object.

    Methods in org.apache.axiom.om that return OMElement
    Modifier and Type | Method and Description
    --- | ---
    `OMElement` | OMElement.`cloneOMElement()` Clones this element and its descendants using default options.
    `OMElement` | OMFactory.`createOMElement(QName qname)` Create an element with the given `QName`.
    `OMElement` | OMFactory.`createOMElement(QName qname, OMContainer parent)` Create an element with the given `QName` and parent.
    `OMElement` | OMFactory.`createOMElement(String localName, OMNamespace ns)` Create an element with the given name.
    `OMElement` | OMFactory.`createOMElement(String localName, OMNamespace ns, OMContainer parent)` Create an element with the given name and parent.
    `OMElement` | OMFactory.`createOMElement(String localName, String namespaceURI, String prefix)` Create an element with the given name.
    `OMElement` | OMXMLParserWrapper.`getDocumentElement()` Get the document element, i.e. the root element of the document.
    `OMElement` | OMXMLParserWrapper.`getDocumentElement(boolean discardDocument)` Get the document element, optionally discarding the document.
    `OMElement` | OMContainer.`getFirstChildWithName(QName qname)` Returns the first child in document order that matches the given QName.
    `OMElement` | OMElement.`getFirstElement()` Returns the first child element of the element.
    `OMElement` | OMDocument.`getOMDocumentElement()` Get the document element.
    `OMElement` | OMAttribute.`getOwner()` Returns the owner element of this attribute

    Methods in org.apache.axiom.om with parameters of type OMElement
    Modifier and Type | Method and Description
    --- | ---
    `void` | OMXMLParserWrapper.`discard(OMElement el)` Deprecated. Use `OMNode.discard()` to discard elements.
    `void` | OMDocument.`setOMDocumentElement(OMElement documentElement)` Set the document element of the XML document.

  - ### Uses of OMElement in org.apache.axiom.om.ds.custombuilder

    Methods in org.apache.axiom.om.ds.custombuilder that return OMElement
    Modifier and Type | Method and Description
    --- | ---
    `OMElement` | ByteArrayCustomBuilder.`create(String namespace, String localPart, OMContainer parent, javax.xml.stream.XMLStreamReader reader, OMFactory factory)`

  - ### Uses of OMElement in org.apache.axiom.om.impl

    Subinterfaces of OMElement in org.apache.axiom.om.impl
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `OMElementEx` Interface that is used internally by Axiom and that should not be considered being part of the public API.

  - ### Uses of OMElement in org.apache.axiom.om.impl.builder

    Methods in org.apache.axiom.om.impl.builder that return OMElement
    Modifier and Type | Method and Description
    --- | ---
    `protected OMElement` | StAXOMBuilder.`constructNode(OMContainer parent, String elementName)` Instantiate the appropriate `OMElement` implementation for the current element.
    `OMElement` | CustomBuilder.`create(String namespace, String localPart, OMContainer parent, javax.xml.stream.XMLStreamReader reader, OMFactory factory)` Create an OMElement for this whole subtree.
    `OMElement` | OMFactoryEx.`createOMElement(String localName, OMContainer parent, OMXMLParserWrapper builder)`
    `OMElement` | StAXOMBuilder.`getDocumentElement()`
    `OMElement` | StAXOMBuilder.`getDocumentElement(boolean discardDocument)`

    Methods in org.apache.axiom.om.impl.builder with parameters of type OMElement
    Modifier and Type | Method and Description
    --- | ---
    `void` | StAXBuilder.`discard(OMElement element)`
    `protected void` | StAXBuilder.`processAttributes(OMElement node)` Method processAttributes.
    `protected void` | StAXOMBuilder.`processNamespaceData(OMElement node)` Method processNamespaceData.
    `protected abstract void` | StAXBuilder.`processNamespaceData(OMElement node)` Method processNamespaceData.
    `static void` | BuilderUtil.`setNamespace(OMElement element, String namespaceURI, String prefix, boolean namespaceURIInterning)`

    Constructors in org.apache.axiom.om.impl.builder with parameters of type OMElement
    Constructor and Description
    `StAXOMBuilder(OMFactory factory, javax.xml.stream.XMLStreamReader parser, OMElement element)` Deprecated. Please use the `OMXMLBuilderFactory` API.
    `StAXOMBuilder(OMFactory factory, javax.xml.stream.XMLStreamReader parser, OMElement element, String characterEncoding)` For internal use only.
    `XOPAwareStAXOMBuilder(OMFactory factory, javax.xml.stream.XMLStreamReader parser, OMElement element, Attachments attachments)` Deprecated. Please use the `OMXMLBuilderFactory` API.

  - ### Uses of OMElement in org.apache.axiom.om.impl.util

    Methods in org.apache.axiom.om.impl.util with parameters of type OMElement
    Modifier and Type | Method and Description
    --- | ---
    `static void` | OMSerializerUtil.`serializeAttributes(OMElement element, javax.xml.stream.XMLStreamWriter writer)` Deprecated. Consider using serializeStartpart instead
    `static void` | OMSerializerUtil.`serializeByPullStream(OMElement element, javax.xml.stream.XMLStreamWriter writer)` Deprecated. This is an internal method that is no longer used.
    `static void` | OMSerializerUtil.`serializeByPullStream(OMElement element, javax.xml.stream.XMLStreamWriter writer, boolean cache)` Deprecated. This is an internal method that is no longer used.
    `static void` | OMSerializerUtil.`serializeNamespaces(OMElement element, javax.xml.stream.XMLStreamWriter writer)` Deprecated. Use serializeStartpart instead
    `static void` | OMSerializerUtil.`serializeNormal(OMElement element, javax.xml.stream.XMLStreamWriter writer, boolean cache)` Deprecated. This is an internal method that is no longer used.
    `static void` | OMSerializerUtil.`serializeStartpart(OMElement element, String localName, javax.xml.stream.XMLStreamWriter writer)` Deprecated. This is an internal method that is no longer used.
    `static void` | OMSerializerUtil.`serializeStartpart(OMElement element, javax.xml.stream.XMLStreamWriter writer)` Deprecated. This is an internal method that is no longer used.

  - ### Uses of OMElement in org.apache.axiom.om.util

    Methods in org.apache.axiom.om.util that return OMElement
    Modifier and Type | Method and Description
    --- | ---
    `static OMElement` | ElementHelper.`getChildWithName(OMElement parent, String childName)` Deprecated. please use OMElement.getFirstChildWithName(qname) instead!
    `static OMElement` | ElementHelper.`importOMElement(OMElement omElement, OMFactory omFactory)` Some times two OMElements needs to be added to the same object tree.
    `static OMElement` | AXIOMUtil.`stringToOM(OMFactory omFactory, String xmlFragment)` Create an OMElement from an XML fragment given as a string.
    `static OMElement` | AXIOMUtil.`stringToOM(String xmlFragment)` Create an OMElement from an XML fragment given as a string.

    Methods in org.apache.axiom.om.util with parameters of type OMElement
    Modifier and Type | Method and Description
    --- | ---
    `Collection` | DigestGenerator.`getAttributesWithoutNS(OMElement element)` Gets the collection of attributes which are none namespace declarations for an OMElement
    `static OMElement` | ElementHelper.`getChildWithName(OMElement parent, String childName)` Deprecated. please use OMElement.getFirstChildWithName(qname) instead!
    `byte[]` | DigestGenerator.`getDigest(OMElement element, String digestAlgorithm)` This method is an overloaded method for the digest generation for OMElement
    `String` | DigestGenerator.`getExpandedName(OMElement element)` This method is an overloaded method for getting the expanded name namespaceURI followed by the local name for OMElement
    `static Reader` | ElementHelper.`getTextAsStream(OMElement element, boolean cache)` Deprecated. Use `getTextAsStream(boolean)` instead.
    `static void` | AttributeHelper.`importOMAttribute(OMAttribute omAttribute, OMElement omElement)` In Axiom, a single tree should always contain objects created from the same type of factory (eg: LinkedListImplFactory, DOMFactory, etc.,).
    `static OMElement` | ElementHelper.`importOMElement(OMElement omElement, OMFactory omFactory)` Some times two OMElements needs to be added to the same object tree.
    `static long` | CommonUtils.`logDebug(OMElement om, org.apache.commons.logging.Log log)` Writes the om to a log.debug.
    `static long` | CommonUtils.`logDebug(OMElement om, org.apache.commons.logging.Log log, int limit)` Writes the om to a log.debug.
    `static long` | CommonUtils.`logDebug(OMElement om, org.apache.commons.logging.Log log, int limit, OMOutputFormat format)` Writes the om to a log.debug.
    `static void` | ElementHelper.`setNewElement(OMElement parent, OMElement myElement, OMElement newElement)` Deprecated.
    `static SOAPHeaderBlock` | ElementHelper.`toSOAPHeaderBlock(OMElement omElement, SOAPFactory factory)` This is a method to convert regular OMElements to SOAPHeaderBlocks.
    `static void` | ElementHelper.`writeTextTo(OMElement element, Writer out, boolean cache)` Deprecated. Use `writeTextTo(Writer, boolean)` instead.

    Constructors in org.apache.axiom.om.util with parameters of type OMElement
    Constructor and Description
    `ElementHelper(OMElement element)` Constructs and binds to an element.

  - ### Uses of OMElement in org.apache.axiom.om.util.jaxb

    Methods in org.apache.axiom.om.util.jaxb with parameters of type OMElement
    Modifier and Type | Method and Description
    --- | ---
    `static Object` | JAXBUtils.`unmarshal(javax.xml.bind.JAXBContext context, OMElement element, boolean cache)` Unmarshal the given element.

  - ### Uses of OMElement in org.apache.axiom.om.xpath

    Methods in org.apache.axiom.om.xpath with parameters of type OMElement
    Modifier and Type | Method and Description
    --- | ---
    `void` | AXIOMXPath.`addNamespaces(OMElement element)` Add the namespace declarations of a given `OMElement` to the namespace context of an XPath expression.

    Constructors in org.apache.axiom.om.xpath with parameters of type OMElement
    Constructor and Description
    `AXIOMXPath(OMElement element, String xpathExpr)` Construct an XPath expression from a given string and initialize its namespace context based on a given element.

  - ### Uses of OMElement in org.apache.axiom.soap

    Subinterfaces of OMElement in org.apache.axiom.soap
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `SOAPBody` An object that represents the contents of the SOAP body element in a SOAP message.
    `interface` | `SOAPEnvelope` Interface SOAPEnvelope
    `interface` | `SOAPFault` An element in the `SOAPBody` object that contains error and/or status information.
    `interface` | `SOAPFaultClassifier` Common superinterface for `SOAPFaultCode` and `SOAPFaultSubCode`.
    `interface` | `SOAPFaultCode`
    `interface` | `SOAPFaultDetail` The Detail element information item is intended for carrying application specific error information related to the SOAP Body .
    `interface` | `SOAPFaultNode`
    `interface` | `SOAPFaultReason`
    `interface` | `SOAPFaultRole` The Role element information item identifies the role the node was operating in at the point the fault occurred.
    `interface` | `SOAPFaultSubCode`
    `interface` | `SOAPFaultText`
    `interface` | `SOAPFaultValue`
    `interface` | `SOAPHeader` Interface SOAPHeader
    `interface` | `SOAPHeaderBlock` An object representing the contents in the SOAP header part of the SOAP envelope.

    Methods in org.apache.axiom.soap with parameters of type OMElement
    Modifier and Type | Method and Description
    --- | ---
    `void` | SOAPFaultDetail.`addDetailEntry(OMElement detailElement)`

  - ### Uses of OMElement in org.apache.axiom.soap.impl.builder

    Methods in org.apache.axiom.soap.impl.builder that return OMElement
    Modifier and Type | Method and Description
    --- | ---
    `protected OMElement` | StAXSOAPModelBuilder.`constructNode(OMContainer parent, String elementName)`
    `abstract OMElement` | SOAPBuilderHelper.`handleEvent(javax.xml.stream.XMLStreamReader parser, OMElement element, int elementLevel)`
    `OMElement` | SOAP12BuilderHelper.`handleEvent(javax.xml.stream.XMLStreamReader parser, OMElement parent, int elementLevel)`
    `OMElement` | SOAP11BuilderHelper.`handleEvent(javax.xml.stream.XMLStreamReader parser, OMElement parent, int elementLevel)`

    Methods in org.apache.axiom.soap.impl.builder with parameters of type OMElement
    Modifier and Type | Method and Description
    --- | ---
    `abstract OMElement` | SOAPBuilderHelper.`handleEvent(javax.xml.stream.XMLStreamReader parser, OMElement element, int elementLevel)`
    `OMElement` | SOAP12BuilderHelper.`handleEvent(javax.xml.stream.XMLStreamReader parser, OMElement parent, int elementLevel)`
    `OMElement` | SOAP11BuilderHelper.`handleEvent(javax.xml.stream.XMLStreamReader parser, OMElement parent, int elementLevel)`

Copyright © The Apache Software Foundation. All Rights Reserved.