org.apache.axiom.om
Interface OMContainer

All Superinterfaces:

OMSerializable

All Known Subinterfaces:

OMContainerEx, OMDocument, OMElement, OMSourcedElement, SOAPBody, SOAPEnvelope, SOAPFault, SOAPFaultClassifier, SOAPFaultCode, SOAPFaultDetail, SOAPFaultNode, SOAPFaultReason, SOAPFaultRole, SOAPFaultSubCode, SOAPFaultText, SOAPFaultValue, SOAPHeader, SOAPHeaderBlock, SOAPMessage

public interface OMContainer
extends OMSerializable

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	getChildrenWithLocalName(java.lang.String localName) Returns an iterator for child nodes matching the local name.
java.util.Iterator	getChildrenWithName(javax.xml.namespace.QName elementQName) Returns an iterator for child nodes matching the given QName.
java.util.Iterator	getChildrenWithNamespaceURI(java.lang.String uri) Returns an iterator for child nodes matching the namespace uri.
OMElement	getFirstChildWithName(javax.xml.namespace.QName elementQName) Returns the first child in document order that matches the given QName
OMNode	getFirstOMChild() Gets the first child.
void	serialize(java.io.OutputStream output) Serializes the node with caching.
void	serialize(java.io.OutputStream output, OMOutputFormat format) Serializes the node with caching.
void	serialize(java.io.Writer writer) Serializes the node with caching.
void	serialize(java.io.Writer writer, OMOutputFormat format) Serializes the node with caching.
void	serializeAndConsume(java.io.OutputStream output) Serializes the node without caching.
void	serializeAndConsume(java.io.OutputStream output, OMOutputFormat format) Serializes the node without caching.
void	serializeAndConsume(java.io.Writer writer) Serializes the node without caching.
void	serializeAndConsume(java.io.Writer writer, OMOutputFormat format) Serializes the node without caching.

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

build, close, getOMFactory, isComplete, serialize, serialize, serializeAndConsume

Method Detail

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 given QName.

Parameters:

elementQName - The QName specifying namespace and local name to match.

Returns:

Returns an iterator of OMElement items that match the given QName

getChildrenWithLocalName

java.util.Iterator getChildrenWithLocalName(java.lang.String localName)

Returns an iterator for child nodes matching the local name.

Parameters:

localName -

Returns:

Returns an iterator of OMElement items that match the given localName

getChildrenWithNamespaceURI

java.util.Iterator getChildrenWithNamespaceURI(java.lang.String uri)

Returns an iterator for child nodes matching the namespace uri.

Parameters:

uri -

Returns:

Returns an iterator of OMElement items that match the given uri

getFirstChildWithName

OMElement getFirstChildWithName(javax.xml.namespace.QName elementQName)
                                throws OMException

Returns the first child in document order that matches the given QName

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.

serialize

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

Serializes the node with caching.

Parameters:

output -

Throws:

javax.xml.stream.XMLStreamException

serialize

void serialize(java.io.Writer writer)
               throws javax.xml.stream.XMLStreamException

Serializes the node with caching.

Parameters:

writer -

Throws:

javax.xml.stream.XMLStreamException

serialize

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

Serializes the node with caching.

Parameters:

output -

format -

Throws:

javax.xml.stream.XMLStreamException

serialize

void serialize(java.io.Writer writer,
               OMOutputFormat format)
               throws javax.xml.stream.XMLStreamException

Serializes the node with caching.

Parameters:

writer -

format -

Throws:

javax.xml.stream.XMLStreamException

serializeAndConsume

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

Serializes the node without caching.

Parameters:

output -

Throws:

javax.xml.stream.XMLStreamException

serializeAndConsume

void serializeAndConsume(java.io.Writer writer)
                         throws javax.xml.stream.XMLStreamException

Serializes the node without caching.

Parameters:

writer -

Throws:

javax.xml.stream.XMLStreamException

serializeAndConsume

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

Serializes the node without caching.

Parameters:

output -

format -

Throws:

javax.xml.stream.XMLStreamException

serializeAndConsume

void serializeAndConsume(java.io.Writer writer,
                         OMOutputFormat format)
                         throws javax.xml.stream.XMLStreamException

Serializes the node without caching.

Parameters:

writer -

format -

Throws:

javax.xml.stream.XMLStreamException

buildNext

void buildNext()