nu.xom
public class Comment extends Node
This class represents an XML comment such as
<-- This is a comment-->
.
A comment node cannot have any child nodes.
It can be a child of an Element
or a Document
.
It has essentially no internal substructure.
Version: 1.0
Constructor Summary | |
---|---|
Comment(String data)
Creates a new | |
Comment(Comment comment) Creates a new comment that's a copy of its argument. |
Method Summary | |
---|---|
Node | copy()
Returns a deep copy of this |
Node | getChild(int position)
Throws |
int | getChildCount() Returns 0 because comments do not have children. |
String | getValue() Returns the value of this comment as defined by XPath 1.0. |
void | setValue(String data)
Sets the content of this |
String | toString() Returns a string form of the comment suitable for debugging and diagnosis. |
String | toXML()
Returns a |
Creates a new Comment
object from string data.
The data is checked for legality according to XML 1.0 rules.
Illegal characters such as the form feed and null are not
allowed. Furthermore, the two hyphen string "--" is not allowed;
and the last character of the comment may not be a hyphen.
Parameters: data the initial text of the comment
Creates a new comment that's a copy of its argument. The copy has the same data but no parent node.
Parameters: comment the comment to copy
Returns a deep copy of this Comment
object
which contains the same text, but does not have any parent.
Thus, it can be inserted into a different document.
Returns: a deep copy of this Comment
that is not part of a document
Throws IndexOutOfBoundsException
because
comments do not have children.
Parameters: position the index of the child node to return
Returns: never returns because comments do not have children; Always throws an exception.
Throws: IndexOutOfBoundsException because comments do not have children
Returns 0 because comments do not have children.
Returns: zero
Returns the value of this comment as defined by XPath 1.0.
The XPath string-value of a comment node is the string
content of the node, not including the initial
<--
and closing -->
.
Returns: the content of the comment
Sets the content of this Comment
object
to the specified string.
This string is checked for legality according to XML 1.0 rules.
Characters that can be serialized such as < and &
are allowed. However, illegal characters such as the form feed
and unmatched halves of surrogate pairs are not allowed.
Furthermore, the string may not contain a double hyphen
(--
) and may not end with a hyphen.
Parameters: data the text to install in the comment
Returns a string form of the comment suitable for debugging and diagnosis. It deliberately does not return an actual XML comment.
Returns: a representation of the Comment
as a String
Returns a String
containing the actual XML
form of the comment;
for example, <--This is a comment-->
.
Returns: a String
containing a well-formed
XML comment