org.apache.axiom.om.impl
Interface OMNodeEx

All Superinterfaces:
OMInformationItem, OMNode, OMSerializable
All Known Subinterfaces:
OMElementEx

public interface OMNodeEx
extends OMNode

Interface that is used internally by Axiom and that should not be considered being part of the public API.


Field Summary
 
Fields inherited from interface org.apache.axiom.om.OMNode
CDATA_SECTION_NODE, COMMENT_NODE, DTD_NODE, ELEMENT_NODE, ENTITY_REFERENCE_NODE, PI_NODE, SPACE_NODE, TEXT_NODE
 
Method Summary
 OMNode getNextOMSiblingIfAvailable()
          Get the next sibling if it is available.
 void internalSerialize(XMLStreamWriter writer)
          Deprecated. This method will be removed in a future version of Axiom. It is only here to maintain backward compatibility with projects using this method despite the fact that it is marked as internal.
 void internalSerialize(XMLStreamWriter writer, boolean cache)
          Serializes the node.
 void internalSerializeAndConsume(XMLStreamWriter writer)
          Deprecated. This method will be removed in a future version of Axiom. It is only here to maintain backward compatibility with projects using this method despite the fact that it is marked as internal.
 void setComplete(boolean state)
           
 void setNextOMSibling(OMNode node)
           
 void setParent(OMContainer element)
           
 void setPreviousOMSibling(OMNode previousSibling)
           
 
Methods inherited from interface org.apache.axiom.om.OMNode
buildWithAttachments, detach, discard, getNextOMSibling, getParent, getPreviousOMSibling, getType, insertSiblingAfter, insertSiblingBefore, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume
 
Methods inherited from interface org.apache.axiom.om.OMSerializable
build, close, isComplete, serialize, serialize, serializeAndConsume
 
Methods inherited from interface org.apache.axiom.om.OMInformationItem
clone, getOMFactory
 

Method Detail

setNextOMSibling

void setNextOMSibling(OMNode node)

setPreviousOMSibling

void setPreviousOMSibling(OMNode previousSibling)

setParent

void setParent(OMContainer element)

setComplete

void setComplete(boolean state)

internalSerialize

void internalSerialize(XMLStreamWriter writer,
                       boolean cache)
                       throws XMLStreamException
Serializes the node. Note that this is an internal method that MUST NOT be used outside of Axiom. Please use OMSerializable.serialize(XMLStreamWriter, boolean) instead.

Parameters:
writer -
cache - indicates if caching should be enabled
Throws:
XMLStreamException

internalSerialize

void internalSerialize(XMLStreamWriter writer)
                       throws XMLStreamException
Deprecated. This method will be removed in a future version of Axiom. It is only here to maintain backward compatibility with projects using this method despite the fact that it is marked as internal.

Throws:
XMLStreamException

internalSerializeAndConsume

void internalSerializeAndConsume(XMLStreamWriter writer)
                                 throws XMLStreamException
Deprecated. This method will be removed in a future version of Axiom. It is only here to maintain backward compatibility with projects using this method despite the fact that it is marked as internal.

Throws:
XMLStreamException

getNextOMSiblingIfAvailable

OMNode getNextOMSiblingIfAvailable()
Get the next sibling if it is available. The sibling 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 sibling. In contrast to OMNode.getNextOMSibling(), this method will never modify the state of the underlying parser.

Returns:
the next sibling or null if the node has no next sibling or the builder has not yet started to build the next sibling


Copyright © 2004-2012 The Apache Software Foundation. All Rights Reserved.