org.apache.axiom.om.impl

Interface OMNodeEx

All Superinterfaces:

OMNode, OMSerializable

All Known Implementing Classes:

AttrImpl, CDATASectionImpl, CharacterImpl, ChildNode, CommentImpl, DocumentFragmentImpl, DocumentImpl, DocumentTypeImpl, ElementImpl, NodeImpl, OMCommentImpl, OMDocTypeImpl, OMElementImpl, OMNodeImpl, OMProcessingInstructionImpl, OMSourcedElementImpl, OMTextImpl, ParentNode, ProcessingInstructionImpl, SOAP11BodyImpl, SOAP11BodyImpl, SOAP11FaultCodeImpl, SOAP11FaultCodeImpl, SOAP11FaultDetailImpl, SOAP11FaultDetailImpl, SOAP11FaultImpl, SOAP11FaultImpl, 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, SOAPTextImpl, SOAPTextImpl, TextImpl, TextNodeImpl

public interface OMNodeEx
extends OMNode

Interface OMNodeEx

Internal Implementation detail. Adding special interface to stop folks from accidently using OMNode. Please use at your own risk. May corrupt the data integrity.

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

Modifier and Type	Method and Description
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)
void	setType(int nodeType)

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, getOMFactory, isComplete, serialize, serialize, serializeAndConsume

Method Detail

setNextOMSibling

void setNextOMSibling(OMNode node)

setPreviousOMSibling

void setPreviousOMSibling(OMNode previousSibling)

setParent

void setParent(OMContainer element)

setComplete

void setComplete(boolean state)

setType

void setType(int nodeType)
      throws OMException

Throws:

OMException

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