org.openxml.dom

Class CommentImpl

java.lang.Object

org.openxml.dom.NodeImpl

org.openxml.dom.CommentImpl

All Implemented Interfaces:

Cloneable, CharacterData, Comment, Node

public final class CommentImpl
extends NodeImpl
implements Comment

Implements a Comment object. This is a text data object whose value can be manipulated using the CharacterData\ interface and does not support children.

Notes:

1. Node type is Node.COMMENT_NODE
2. Node does not support children
3. Node name is always "#comment"

Author:

Assaf Arkin

See Also:

Comment, CharacterDataImpl

Field Summary

Fields inherited from class org.openxml.dom.NodeImpl

ATTLIST_DECL_NODE, ELEMENT_DECL_NODE, PARAM_ENTITY_NODE

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

Constructor Summary

Constructors

Constructor and Description
CommentImpl(DocumentImpl owner, String comment) Hidden constructor.

Method Summary

Modifier and Type	Method and Description
void	appendData(String value)
Object	clone()
Node	cloneNode(boolean deep)
short	compareDocumentPosition(Node other)
void	deleteData(int offset, int count)
String	getBaseURI()
String	getData()
Object	getFeature(String feature, String version)
int	getLength()
short	getNodeType() Abstract method must be implemented by each node class.
String	getTextContent()
Object	getUserData(String key)
boolean	hasAttributes()
void	insertData(int offset, String value)
boolean	isDefaultNamespace(String namespaceURI)
boolean	isEqualNode(Node arg)
boolean	isSameNode(Node other)
boolean	isSupported(String feature, String version)
String	lookupNamespaceURI(String prefix)
String	lookupPrefix(String namespaceURI)
void	replaceData(int offset, int count, String value)
void	setData(String value)
void	setTextContent(String textContent)
Object	setUserData(String key, Object data, UserDataHandler handler)
String	substringData(int start, int count)
String	toString()

Methods inherited from class org.openxml.dom.NodeImpl

appendChild, cloneInto, equals, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, hasChildNodes, insertBefore, isReadOnly, makeReadOnly, normalize, removeChild, replaceChild, setNodeValue, setOwnerDocument, setPrefix, supports

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, 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, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, hasChildNodes, insertBefore, normalize, removeChild, replaceChild, setNodeValue, setPrefix

Constructor Detail

CommentImpl

public CommentImpl(DocumentImpl owner,
                   String comment)

Hidden constructor.

Parameters:

owner - The owner of this document

comment - Comment text

Method Detail

getNodeType

public short getNodeType()

Description copied from class: NodeImpl

Abstract method must be implemented by each node class.

Specified by:

getNodeType in interface Node

Specified by:

getNodeType in class NodeImpl

See Also:

Node.getNodeType()

clone

public final Object clone()

Overrides:

clone in class Object

cloneNode

public final Node cloneNode(boolean deep)

Specified by:

cloneNode in interface Node

toString

public String toString()

Overrides:

toString in class Object

compareDocumentPosition

public short compareDocumentPosition(Node other)
                              throws DOMException

Specified by:

compareDocumentPosition in interface Node

Throws:

DOMException

getBaseURI

public String getBaseURI()

Specified by:

getBaseURI in interface Node

getFeature

public Object getFeature(String feature,
                         String version)

Specified by:

getFeature in interface Node

getTextContent

public String getTextContent()
                      throws DOMException

Specified by:

getTextContent in interface Node

Throws:

DOMException

getUserData

public Object getUserData(String key)

Specified by:

getUserData in interface Node

isDefaultNamespace

public boolean isDefaultNamespace(String namespaceURI)

Specified by:

isDefaultNamespace in interface Node

isEqualNode

public boolean isEqualNode(Node arg)

Specified by:

isEqualNode in interface Node

isSameNode

public boolean isSameNode(Node other)

Specified by:

isSameNode in interface Node

lookupNamespaceURI

public String lookupNamespaceURI(String prefix)

Specified by:

lookupNamespaceURI in interface Node

lookupPrefix

public String lookupPrefix(String namespaceURI)

Specified by:

lookupPrefix in interface Node

setTextContent

public void setTextContent(String textContent)
                    throws DOMException

Specified by:

setTextContent in interface Node

Throws:

DOMException

setUserData

public Object setUserData(String key,
                          Object data,
                          UserDataHandler handler)

Specified by:

setUserData in interface Node

hasAttributes

public boolean hasAttributes()

Specified by:

hasAttributes in interface Node

isSupported

public boolean isSupported(String feature,
                           String version)

Specified by:

isSupported in interface Node

getData

public final String getData()

Specified by:

getData in interface CharacterData

setData

public final void setData(String value)
                   throws DOMException

Specified by:

setData in interface CharacterData

Throws:

DOMException

getLength

public final int getLength()

Specified by:

getLength in interface CharacterData

substringData

public final String substringData(int start,
                                  int count)
                           throws DOMException

Specified by:

substringData in interface CharacterData

Throws:

DOMException

appendData

public final void appendData(String value)

Specified by:

appendData in interface CharacterData

insertData

public final void insertData(int offset,
                             String value)
                      throws DOMException

Specified by:

insertData in interface CharacterData

Throws:

DOMException

deleteData

public final void deleteData(int offset,
                             int count)
                      throws DOMException

Specified by:

deleteData in interface CharacterData

Throws:

DOMException

replaceData

public final void replaceData(int offset,
                              int count,
                              String value)
                       throws DOMException

Specified by:

replaceData in interface CharacterData

Throws:

DOMException