org.apache.axiom.om.impl.common
Interface IParentNode

All Known Subinterfaces:

IContainer, IElement

public interface IParentNode

Interface for parent nodes. This interface is implemented by OMContainer implementations as well as nodes that can have children, but that are not OMContainer implementations (such as DOOM's Attr and DocumentFragment implementations).

Field Summary

static int	COMPLETE
static int	DISCARDED
static int	INCOMPLETE

Method Summary

OMXMLParserWrapper	getBuilder()
OMNode	getFirstOMChildIfAvailable() Get the first child if it is available.
int	getState()
boolean	isComplete()

Field Detail

INCOMPLETE

static final int INCOMPLETE

See Also:

Constant Field Values

COMPLETE

static final int COMPLETE

See Also:

Constant Field Values

DISCARDED

static final int DISCARDED

See Also:

Constant Field Values

Method Detail

getBuilder

OMXMLParserWrapper getBuilder()

getState

int getState()

isComplete

boolean isComplete()

getFirstOMChildIfAvailable

OMNode getFirstOMChildIfAvailable()

Get the first child if it is available. The child is available if it is complete or if the builder has started building the node. In the latter case, OMSerializable.isComplete() may return false when called on the child. In contrast to OMContainer.getFirstOMChild(), this method will never modify the state of the underlying parser.

Returns:

the first child or null if the container has no children or the builder has not yet started to build the first child