XML for Java Compatibility API 2.0.13

com.ibm.xml.parser
Class TXComment

java.lang.Object
  |
  +--com.ibm.xml.parser.Child
        |
        +--com.ibm.xml.parser.TXCharacterData
              |
              +--com.ibm.xml.parser.TXComment
Direct Known Subclasses:
TreeFactory.TreeComment

public class TXComment
extends TXCharacterData
implements org.w3c.dom.Comment

The TXComment class implements the Comment interface as defined by the Document Object Model (DOM).

A TXComment Node represents the content of a comment, i.e. all the characters between the starting '<!--' and ending '-->'.

Version:
Revision: 00 1.5 src/com/ibm/xml/parser/TXComment.java, parser, xml4j2, xml4j2_0_13
See Also:
Comment, Child, Serialized Form

Fields inherited from class com.ibm.xml.parser.Child
ATTDEF, ATTLIST, ELEMENT_DECL, NAME_ATTDEF, NAME_ATTLIST, NAME_CDATA, NAME_COMMENT, NAME_DOCFRAGMENT, NAME_DOCUMENT, NAME_ELEMENT_DECL, NAME_PSEUDONODE, NAME_TEXT, PSEUDONODE
 
Constructor Summary
TXComment(java.lang.String data)
          Constructor.
 
Method Summary
 void acceptPost(Visitor visitor)
          Implements the accept operation of the visitor design pattern when the end of a TXComment Node is recognized when traversing the document object tree.
 void acceptPre(Visitor visitor)
          Implements the accept operation of the visitor design pattern when the start of a TXComment Node is recognized when traversing the document object tree.
 java.lang.Object clone()
          Clone this Comment Node using the appropriate factory.
 boolean equals(org.w3c.dom.Node arg, boolean deep)
           
 java.lang.String getNodeName()
          This method is defined by DOM.
 short getNodeType()
          Returns that this object is a Comment Node.
 java.lang.String getText()
          Return all text associated with this Node without considering entities.
 
Methods inherited from class com.ibm.xml.parser.TXCharacterData
appendData, deleteData, getData, getLength, getNodeValue, insertData, replaceData, setData, setNodeValue, substringData
 
Methods inherited from class com.ibm.xml.parser.Child
appendChild, clearDigest, cloneNode, getAttributes, getChildNodes, getDigest, getFactory, getFirstChild, getFirstWithoutReference, getLastChild, getLastWithoutReference, getNextSibling, getNextWithoutReference, getOwnerDocument, getParentNode, getParentWithoutReference, getPreviousSibling, getPreviousWithoutReference, getUserData, hasChildNodes, insertBefore, makeXPointer, print, print, removeChild, replaceChild, searchAncestors, searchAncestors, setFactory, setUserData, toXMLString, toXMLString
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TXComment

public TXComment(java.lang.String data)
Constructor.
Parameters:
data - The actual content of the Comment Node.
Method Detail

clone

public java.lang.Object clone()
Clone this Comment Node using the appropriate factory.

This method is defined by Child.

Returns:
Cloned Comment Node.
Overrides:
clone in class Child
See Also:
Child.clone()

equals

public boolean equals(org.w3c.dom.Node arg,
                      boolean deep)
Parameters:
deep - Ignored.
Overrides:
equals in class Child

getNodeType

public short getNodeType()
Returns that this object is a Comment Node.

This method is defined by DOM.

Returns:
Comment Node indicator.

getNodeName

public java.lang.String getNodeName()

This method is defined by DOM.


getText

public java.lang.String getText()
Return all text associated with this Node without considering entities.

This method is defined by Child.

Returns:
Always returns "".
Overrides:
getText in class Child
See Also:
Child.toXMLString(java.io.Writer, java.lang.String)

acceptPre

public void acceptPre(Visitor visitor)
               throws java.lang.Exception
Implements the accept operation of the visitor design pattern when the start of a TXComment Node is recognized when traversing the document object tree.
Parameters:
visitor - The implemention of the Visitor operation (toXMLString, digest, ...)
Throws:
java.lang.Exception - Thrown if this Node can not be visitted, or traversal modification is requested.
See Also:
Visitor, TreeTraversal, NonRecursivePreorderTreeTraversal, TreeTraversalException

acceptPost

public void acceptPost(Visitor visitor)
                throws java.lang.Exception
Implements the accept operation of the visitor design pattern when the end of a TXComment Node is recognized when traversing the document object tree.
Parameters:
visitor - The implemention of the Visitor operation (toXMLString, digest, ...)
Throws:
java.lang.Exception - Thrown if this Node can not be visitted, or traversal modification is requested.
See Also:
Visitor, TreeTraversal, NonRecursivePreorderTreeTraversal, TreeTraversalException

XML for Java Compatibility API 2.0.13