org.apache.axiom.om
Interface OMContainer
- All Known Subinterfaces:
- OMContainerEx, OMDocument, OMElement, SOAPBody, SOAPEnvelope, SOAPFault, SOAPFaultCode, SOAPFaultDetail, SOAPFaultNode, SOAPFaultReason, SOAPFaultRole, SOAPFaultSubCode, SOAPFaultText, SOAPFaultValue, SOAPHeader, SOAPHeaderBlock, SOAPMessage
- All Known Implementing Classes:
- DocumentFragmentimpl, DocumentImpl, ElementImpl, OMDocumentImpl, OMElementImpl, OMSourcedElementImpl, ParentNode, SOAP11BodyImpl, SOAP11BodyImpl, SOAP11FaultCodeImpl, SOAP11FaultCodeImpl, SOAP11FaultDetailImpl, SOAP11FaultDetailImpl, SOAP11FaultImpl, SOAP11FaultImpl, SOAP11FaultNodeImpl, SOAP11FaultNodeImpl, SOAP11FaultReasonImpl, SOAP11FaultReasonImpl, SOAP11FaultRoleImpl, SOAP11FaultRoleImpl, SOAP11FaultSubCodeImpl, SOAP11FaultSubCodeImpl, SOAP11FaultTextImpl, SOAP11FaultTextImpl, SOAP11FaultValueImpl, SOAP11FaultValueImpl, SOAP11HeaderBlockImpl, SOAP11HeaderBlockImpl, SOAP11HeaderImpl, SOAP11HeaderImpl, SOAP12BodyImpl, SOAP12BodyImpl, SOAP12FaultCodeImpl, SOAP12FaultCodeImpl, SOAP12FaultDetailImpl, SOAP12FaultDetailImpl, SOAP12FaultImpl, SOAP12FaultImpl, SOAP12FaultNodeImpl, SOAP12FaultNodeImpl, SOAP12FaultReasonImpl, SOAP12FaultReasonImpl, SOAP12FaultRoleImpl, SOAP12FaultRoleImpl, SOAP12FaultSubCodeImpl, SOAP12FaultSubCodeImpl, SOAP12FaultTextImpl, SOAP12FaultTextImpl, SOAP12FaultValueImpl, SOAP12FaultValueImpl, SOAP12HeaderBlockImpl, SOAP12HeaderBlockImpl, SOAP12HeaderImpl, SOAP12HeaderImpl, SOAPBodyImpl, SOAPBodyImpl, SOAPElement, SOAPElement, SOAPEnvelopeImpl, SOAPEnvelopeImpl, SOAPFaultCodeImpl, SOAPFaultCodeImpl, SOAPFaultDetailImpl, SOAPFaultDetailImpl, SOAPFaultImpl, SOAPFaultImpl, SOAPFaultNodeImpl, SOAPFaultNodeImpl, SOAPFaultReasonImpl, SOAPFaultReasonImpl, SOAPFaultRoleImpl, SOAPFaultRoleImpl, SOAPFaultSubCodeImpl, SOAPFaultSubCodeImpl, SOAPFaultTextImpl, SOAPFaultTextImpl, SOAPFaultValueImpl, SOAPFaultValueImpl, SOAPHeaderBlockImpl, SOAPHeaderBlockImpl, SOAPHeaderImpl, SOAPHeaderImpl, SOAPMessageImpl, SOAPMessageImpl, SOAPTextImpl, SOAPTextImpl
public interface OMContainer
Captures the operations related to containment shared by both a document and an element.
Exposes the ability to add, find, and iterate over the children of a document or
element.
Method Summary |
void |
addChild(OMNode omNode)
Adds the given node as the last child. |
void |
buildNext()
|
java.util.Iterator |
getChildren()
Returns an iterator for the children of the container. |
java.util.Iterator |
getChildrenWithName(javax.xml.namespace.QName elementQName)
Returns an iterator for child nodes matching the criteria indicated by the given QName. |
OMElement |
getFirstChildWithName(javax.xml.namespace.QName elementQName)
Returns the first child in document order that matches the given QName criteria. |
OMNode |
getFirstOMChild()
Gets the first child. |
boolean |
isComplete()
|
addChild
void addChild(OMNode omNode)
- Adds the given node as the last child. One must preserve the order of children,
in this operation.
Tip : appending the new child is preferred.
- Parameters:
omNode
-
getChildrenWithName
java.util.Iterator getChildrenWithName(javax.xml.namespace.QName elementQName)
- Returns an iterator for child nodes matching the criteria indicated by the given QName.
This function searches in three ways:
- Exact match - Both parts of the passed QName are non-null. Only children with the
same namespace and local name will be returned.
- Namespace match - The local name of the passed QName is null. All children matching the
namespace will be returned by the iterator.
- Local name match - The namespace of the passed QName is null. All children with the
matching local name will be returned by the iterator.
Example: header.getChildrenWithName( new QName(ADDRESSING_NAMESPACE, null));
will return all of the "addressing" headers.
- Parameters:
elementQName
- The QName specifying namespace and local name to match.
- Returns:
- Returns an iterator of
OMElement
items that match the given QName appropriately.
getFirstChildWithName
OMElement getFirstChildWithName(javax.xml.namespace.QName elementQName)
throws OMException
- Returns the first child in document order that matches the given QName criteria.
The QName filter is applied as in the function getChildrenWithName(javax.xml.namespace.QName)
.
- Parameters:
elementQName
- The QName to use for matching.
- Returns:
- Returns the first element in document order that matches the elementQName criteria.
- Throws:
OMException
- Could indirectly trigger building of child nodes.- See Also:
getChildrenWithName(javax.xml.namespace.QName)
getChildren
java.util.Iterator getChildren()
- Returns an iterator for the children of the container.
- Returns:
- Returns a
Iterator
of children, all of which implement OMNode
. - See Also:
getFirstChildWithName(javax.xml.namespace.QName)
,
getChildrenWithName(javax.xml.namespace.QName)
getFirstOMChild
OMNode getFirstOMChild()
- Gets the first child.
- Returns:
- Returns the first child. May return null if the container has no children.
isComplete
boolean isComplete()
buildNext
void buildNext()