org.htmlunit.html

Class DomComment

java.lang.Object

org.htmlunit.html.DomNode

org.htmlunit.html.DomCharacterData

org.htmlunit.html.DomComment

All Implemented Interfaces:

Serializable, Cloneable, CharacterData, Comment, Node

public class DomComment
extends DomCharacterData
implements Comment

Wrapper for the DOM node Comment.

Author:

Karel Kolman, Ahmed Ashour, Ronald Brill

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.htmlunit.html.DomNode

DomNode.ChildIterator, DomNode.DescendantDomElementsIterator, DomNode.DescendantDomNodesIterator, DomNode.DescendantHtmlElementsIterator

Field Summary

Fields

Modifier and Type	Field and Description
static String	NODE_NAME The symbolic node name.

Fields inherited from class org.htmlunit.html.DomNode

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

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	getNodeName()
short	getNodeType()
protected boolean	printXml(String indent, boolean tagBefore, PrintWriter printWriter) Recursively writes the XML data for the node tree starting at node.
void	setPrefix(String prefix)
String	toString() Returns a simple string representation to facilitate debugging.

Methods inherited from class org.htmlunit.html.DomCharacterData

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

Methods inherited from class org.htmlunit.html.DomNode

addCharacterDataChangeListener, addDomChangeListener, appendChild, asNormalizedText, asXml, basicRemove, checkChildHierarchy, cloneNode, closest, compareDocumentPosition, detach, fireCharacterDataChanged, fireNodeAdded, fireNodeDeleted, getAncestors, getAttributes, getBaseURI, getByXPath, getByXPath, getChildNodes, getChildren, getDescendants, getDomElementDescendants, getEndColumnNumber, getEndLineNumber, getFeature, getFirstByXPath, getFirstByXPath, getFirstChild, getHtmlElementDescendants, getHtmlPageOrNull, getIndex, getLastChild, getLocalName, getNamespaceURI, getNextElementSibling, getNextSibling, getOwnerDocument, getPage, getParentNode, getPrefix, getPreviousElementSibling, getPreviousSibling, getReadyState, getScriptableObject, getSelectorList, getStartColumnNumber, getStartLineNumber, getTextContent, getUserData, getVisibleText, handles, hasAttributes, hasChildNodes, hasFeature, insertBefore, insertBefore, isAncestorOf, isAncestorOfAny, isAttachedToPage, isDefaultNamespace, isDisplayed, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, mayBeDisplayed, normalize, notifyIncorrectness, onAddedToDocumentFragment, onAddedToPage, onAllChildrenAddedToPage, parseHtmlSnippet, printChildrenAsXml, processImportNode, querySelector, querySelectorAll, quietlyRemoveAndMoveChildrenTo, remove, removeAllChildren, removeCharacterDataChangeListener, removeChild, removeDomChangeListener, replace, replaceChild, setEndLocation, setParentNode, setReadyState, setScriptableObject, setStartLocation, 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, 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()

Specified by:

getNodeType in interface Node

Returns:

the node type constant, in this case Node.COMMENT_NODE

getNodeName

public String getNodeName()

Specified by:

getNodeName in interface Node

Returns:

the node name, in this case NODE_NAME

printXml

protected boolean printXml(String indent,
                           boolean tagBefore,
                           PrintWriter printWriter)

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

Overrides:

printXml in class DomNode

Parameters:

indent - white space to indent child nodes

tagBefore - true if the last thing printed was a tag

printWriter - writer where child nodes are written

Returns:

true if the last thing printed was a tag

toString

public String toString()

Returns a simple string representation to facilitate debugging.

Overrides:

toString in class Object

Returns:

a simple string representation

setPrefix

public void setPrefix(String prefix)

Specified by:

setPrefix in interface Node