org.apache.axiom.om.impl.dom

Class DocumentFragmentImpl

java.lang.Object

org.apache.axiom.om.impl.dom.NodeImpl

org.apache.axiom.om.impl.dom.ParentNode

org.apache.axiom.om.impl.dom.RootNode

org.apache.axiom.om.impl.dom.DocumentFragmentImpl

All Implemented Interfaces:

IContainer, IParentNode, OMContainerEx, OMContainer, OMInformationItem, OMSerializable, DocumentFragment, Node, NodeList

public class DocumentFragmentImpl
extends RootNode
implements DocumentFragment, IContainer

Field Summary

Fields inherited from class org.apache.axiom.om.impl.dom.ParentNode

firstChild, lastChild

Fields inherited from class org.apache.axiom.om.impl.dom.NodeImpl

factory, FIRSTCHILD, flags, HAS_PARENT, SPECIFIED

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Fields inherited from interface org.apache.axiom.om.impl.common.IParentNode

COMPLETE, DISCARDED, INCOMPLETE

Constructor Summary

Constructors

Constructor and Description
DocumentFragmentImpl(OMFactory factory)

Method Summary

Modifier and Type	Method and Description
void	build() Builds itself.
void	discarded()
OMXMLParserWrapper	getBuilder() Returns the builder object.
Node	getNextSibling()
String	getNodeName()
short	getNodeType()
int	getState()
void	internalSerialize(XMLStreamWriter writer, boolean cache)
boolean	isComplete() Indicates whether parser has parsed this information item completely or not.
String	lookupNamespaceURI(String specifiedPrefix)
void	removeChildren() Remove all children from this container.
void	serialize(XMLStreamWriter xmlWriter) Serializes the information item with caching.
void	serializeAndConsume(XMLStreamWriter xmlWriter) Serializes the information item without caching.
void	setComplete(boolean state)

Methods inherited from class org.apache.axiom.om.impl.dom.ParentNode

addChild, addChild, appendChild, getChildNodes, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getDescendants, getFirstChild, getFirstChildWithName, getFirstOMChild, getFirstOMChildIfAvailable, getLastChild, getLastKnownOMChild, getLength, getSAXSource, getTextContent, getXMLStreamReader, getXMLStreamReader, getXMLStreamReader, getXMLStreamReaderWithoutCaching, hasChildNodes, insertBefore, item, removeChild, replaceChild, setFirstChild, setLastChild, setTextContent

Methods inherited from class org.apache.axiom.om.impl.dom.NodeImpl

buildWithAttachments, clone, cloneNode, close, compareDocumentPosition, detach, getAttributes, getBaseURI, getFeature, getLocalName, getNamespaceURI, getNextOMSiblingIfAvailable, getNodeValue, getOMFactory, getOwnerDocument, getParent, getParentNode, getPrefix, getPreviousOMSibling, getPreviousSibling, getUserData, hasAttributes, insertSiblingAfter, insertSiblingBefore, internalSerialize, internalSerializeAndConsume, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupPrefix, normalize, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setNextOMSibling, setNodeValue, setParent, setParent, setPrefix, setPreviousOMSibling, setUserData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.w3c.dom.Node

appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

Methods inherited from interface org.apache.axiom.om.impl.common.IContainer

getLastKnownOMChild, setFirstChild, setLastChild

Methods inherited from interface org.apache.axiom.om.impl.OMContainerEx

addChild

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

addChild, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getDescendants, getFirstChildWithName, getFirstOMChild, getSAXSource, getXMLStreamReader, getXMLStreamReader, getXMLStreamReader, getXMLStreamReaderWithoutCaching, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume

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

close, serialize

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

clone, getOMFactory

Methods inherited from interface org.apache.axiom.om.impl.common.IParentNode

getFirstOMChildIfAvailable

Constructor Detail

DocumentFragmentImpl

public DocumentFragmentImpl(OMFactory factory)

Parameters:

ownerDocument -

Method Detail

getNodeType

public short getNodeType()

Specified by:

getNodeType in interface Node

getNodeName

public String getNodeName()

Specified by:

getNodeName in interface Node

internalSerialize

public void internalSerialize(XMLStreamWriter writer,
                              boolean cache)
                       throws XMLStreamException

Specified by:

internalSerialize in class NodeImpl

Throws:

XMLStreamException

serialize

public void serialize(XMLStreamWriter xmlWriter)
               throws XMLStreamException

Description copied from interface: OMSerializable

Serializes the information item with caching. This method has the same effect as OMSerializable.serialize(XMLStreamWriter, boolean) with cache set to true.

Specified by:

serialize in interface OMSerializable

Overrides:

serialize in class NodeImpl

Throws:

XMLStreamException

serializeAndConsume

public void serializeAndConsume(XMLStreamWriter xmlWriter)
                         throws XMLStreamException

Description copied from interface: OMSerializable

Serializes the information item without caching. This method has the same effect as OMSerializable.serialize(XMLStreamWriter, boolean) with cache set to false.

Specified by:

serializeAndConsume in interface OMSerializable

Overrides:

serializeAndConsume in class NodeImpl

Throws:

XMLStreamException

getBuilder

public final OMXMLParserWrapper getBuilder()

Description copied from interface: OMContainer

Returns the builder object.

Specified by:

getBuilder in interface IParentNode

Specified by:

getBuilder in interface OMContainer

Specified by:

getBuilder in class NodeImpl

Returns:

Returns the builder object used to construct the underlying XML infoset on the fly.

getState

public final int getState()

Specified by:

getState in interface IParentNode

isComplete

public final boolean isComplete()

Description copied from interface: OMSerializable

Indicates whether parser has parsed this information item completely or not. If some info are not available in the item, one has to check this attribute to make sure that, this item has been parsed completely or not.

Specified by:

isComplete in interface IParentNode

Specified by:

isComplete in interface OMSerializable

Specified by:

isComplete in class NodeImpl

Returns:

Returns boolean.

setComplete

public final void setComplete(boolean state)

Specified by:

setComplete in interface OMContainerEx

Specified by:

setComplete in class NodeImpl

discarded

public final void discarded()

Specified by:

discarded in interface OMContainerEx

build

public final void build()

Description copied from interface: OMSerializable

Builds itself.

Specified by:

build in interface OMSerializable

getNextSibling

public final Node getNextSibling()

Specified by:

getNextSibling in interface Node

removeChildren

public void removeChildren()

Description copied from interface: OMContainer

Remove all children from this container. This method has the same effect as the following code:

 for (Iterator it = container.getChildren(); it.hasNext(); ) {
     it.next();
     it.remove();
 }

However, the implementation may do this in an optimized way. In particular, if the node is incomplete, it may choose not to instantiate child node that would become unreachable anyway.

Specified by:

removeChildren in interface OMContainer

lookupNamespaceURI

public final String lookupNamespaceURI(String specifiedPrefix)

Specified by:

lookupNamespaceURI in interface Node