org.apache.axiom.om.impl.dom

Class CommentImpl

java.lang.Object

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

org.apache.axiom.om.impl.dom.ChildNode

org.apache.axiom.om.impl.dom.CharacterImpl

org.apache.axiom.om.impl.dom.CommentImpl

All Implemented Interfaces:

Cloneable, OMNodeEx, OMComment, OMNode, OMSerializable, CharacterData, Comment, Node, NodeList

public class CommentImpl
extends CharacterImpl
implements Comment, OMComment

Field Summary

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

textValue

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

nextSibling, parentNode, previousSibling

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

builder, done, factory, FIRSTCHILD, flags, NORMALIZED, OWNED, ownerNode, READONLY, 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.OMNode

CDATA_SECTION_NODE, COMMENT_NODE, DTD_NODE, ELEMENT_NODE, ENTITY_REFERENCE_NODE, PI_NODE, SPACE_NODE, TEXT_NODE

Constructor Summary

Constructors

Constructor and Description
CommentImpl(DocumentImpl ownerNode, OMFactory factory)
CommentImpl(DocumentImpl ownerNode, String value, OMFactory factory)

Method Summary

Modifier and Type	Method and Description
String	getNodeName()
short	getNodeType()
int	getType() Returns the type of node.
String	getValue() Returns the value of this comment as defined by XPath 1.0.
void	internalSerialize(XMLStreamWriter writer, boolean cache) Serializes the node.
void	setType(int nodeType)
void	setValue(String text) Sets the content of this comment to the specified string.

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

appendData, deleteData, getData, getLength, insertData, replaceData, setData, substringData

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

cloneNode, detach, discard, getNextOMSibling, getNextOMSiblingIfAvailable, getNextSibling, getParent, getParentNode, getPreviousOMSibling, getPreviousSibling, insertSiblingAfter, insertSiblingBefore, setNextOMSibling, setParent, setPreviousOMSibling

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

appendChild, build, buildWithAttachments, close, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNodeValue, getOMFactory, getOwnerDocument, getPrefix, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, internalSerialize, internalSerializeAndConsume, isComplete, isDefaultNamespace, isEqualNode, isSameNode, isSupported, item, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, serialize, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setComplete, setNodeValue, setOwnerDocument, setPrefix, setTextContent, 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.CharacterData

appendData, deleteData, getData, getLength, insertData, replaceData, setData, substringData

Methods inherited from interface org.w3c.dom.Node

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

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

buildWithAttachments, detach, discard, getNextOMSibling, getParent, getPreviousOMSibling, 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

Constructor Detail

CommentImpl

public CommentImpl(DocumentImpl ownerNode,
                   OMFactory factory)

CommentImpl

public CommentImpl(DocumentImpl ownerNode,
                   String value,
                   OMFactory factory)

Method Detail

getNodeName

public String getNodeName()

Specified by:

getNodeName in interface Node

getNodeType

public short getNodeType()

Specified by:

getNodeType in interface Node

getValue

public String getValue()

Description copied from interface: OMComment

Returns the value of this comment as defined by XPath 1.0.

Specified by:

getValue in interface OMComment

Returns:

Returns String.

setValue

public void setValue(String text)

Description copied from interface: OMComment

Sets the content of this comment to the specified string.

Specified by:

setValue in interface OMComment

getType

public int getType()

Description copied from interface: OMNode

Returns the type of node.

Specified by:

getType in interface OMNode

Returns:

Returns one of OMNode.ELEMENT_NODE, OMNode.TEXT_NODE, OMNode.CDATA_SECTION_NODE, OMNode.COMMENT_NODE, OMNode.DTD_NODE, OMNode.PI_NODE, OMNode.ENTITY_REFERENCE_NODE or OMNode.SPACE_NODE.

setType

public void setType(int nodeType)
             throws OMException

Specified by:

setType in interface OMNodeEx

Throws:

OMException

internalSerialize

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

Description copied from interface: OMNodeEx

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.

Specified by:

internalSerialize in interface OMNodeEx

cache - indicates if caching should be enabled

Throws:

XMLStreamException