com.gargoylesoftware.htmlunit.html
Class DomComment

java.lang.Object
  com.gargoylesoftware.htmlunit.html.DomNode
      com.gargoylesoftware.htmlunit.html.DomCharacterData
          com.gargoylesoftware.htmlunit.html.DomComment

All Implemented Interfaces:

Serializable, Cloneable, CharacterData, Comment, Node

public class DomComment
extends DomCharacterData
implements Comment

Wrapper for the DOM node Comment.

Version:

$Revision: 5301 $

Author:

Karel Kolman, Ahmed Ashour

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.gargoylesoftware.htmlunit.html.DomNode

DomNode.ChildIterator, DomNode.DescendantElementsIterator<T extends DomNode>

Field Summary

static String

NODE_NAME The symbolic node name.

Fields inherited from class com.gargoylesoftware.htmlunit.html.DomNode

AS_TEXT_BLANK, AS_TEXT_BLOCK_SEPARATOR, AS_TEXT_NEW_LINE, AS_TEXT_TAB, PROPERTY_ELEMENT, READY_STATE_COMPLETE, READY_STATE_INTERACTIVE, READY_STATE_LOADED, READY_STATE_LOADING, READY_STATE_UNINITIALIZED

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

DomComment(SgmlPage page, String data)
Creates an instance of DomComment.

Method Summary

String	getNodeName() Returns this node's node name.
short	getNodeType() Returns this node's node type.
protected void	printXml(String indent, PrintWriter printWriter) Recursively write the XML data for the node tree starting at node.
String	toString() Returns a simple string representation to facilitate debugging.

Methods inherited from class com.gargoylesoftware.htmlunit.html.DomCharacterData

appendData, deleteData, getCanonicalXPath, getData, getLength, getNodeValue, insertData, replaceData, setData, setNodeValue, setTextContent, substringData

Methods inherited from class com.gargoylesoftware.htmlunit.html.DomNode

addDomChangeListener, appendChild, asText, asXml, checkChildHierarchy, cloneNode, compareDocumentPosition, fireNodeAdded, fireNodeDeleted, getAllHtmlChildElements, getAncestors, getAttributes, getBaseURI, getByXPath, getChildNodes, getChildren, getDescendants, getEndColumnNumber, getEndLineNumber, getFeature, getFirstByXPath, getFirstChild, getHtmlElementDescendants, getIndex, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getOwnerDocument, getPage, getParentNode, getPrefix, getPreviousSibling, getReadyState, getScriptObject, getStartColumnNumber, getStartLineNumber, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, insertBefore, isAncestorOf, isAncestorOfAny, isBlock, isDefaultNamespace, isDisplayed, isEqualNode, isSameNode, isSupported, isTrimmedText, lookupNamespaceURI, lookupPrefix, mayBeDisplayed, normalize, notifyIncorrectness, onAddedToPage, onAllChildrenAddedToPage, printChildrenAsXml, remove, removeAllChildren, removeChild, removeDomChangeListener, replace, replaceChild, setNextSibling, setParentNode, setPrefix, setPreviousSibling, setReadyState, setScriptObject, setUserData

Methods inherited from class java.lang.Object

clone, equals, 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, 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

Field Detail

NODE_NAME

public static final String NODE_NAME

The symbolic node name.

See Also:

Constant Field Values

Constructor Detail

DomComment

public DomComment(SgmlPage page,
                  String data)

Creates an instance of DomComment.

Parameters:

page - the Page that contains this element

data - the string data held by this node

Method Detail

getNodeType

public short getNodeType()

Returns this node's node type.

Specified by:

getNodeType in interface Node

Specified by:

getNodeType in class DomNode

Returns:

the node type constant, in this case Node.COMMENT_NODE

getNodeName

public String getNodeName()

Description copied from class: DomNode

Returns this node's node name.

Specified by:

getNodeName in interface Node

Specified by:

getNodeName in class DomNode

Returns:

the node name, in this case NODE_NAME

printXml

protected void printXml(String indent,
                        PrintWriter printWriter)

Recursively write the XML data for the node tree starting at node.

Overrides:

printXml in class DomNode

Parameters:

indent - white space to indent child nodes

printWriter - writer where child nodes are written

toString

public String toString()

Returns a simple string representation to facilitate debugging.

Overrides:

toString in class Object

Returns:

a simple string representation