| |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Objectnu.xom.Node
nu.xom.Comment
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.
Constructor Summary | |
Comment(Comment comment)
Creates a new comment that's a copy of its argument. | |
Comment(String data)
Creates a new Comment object from string data. |
Method Summary | |
Node | copy()
Returns a deep copy of this Comment object
which contains the same text, but does not have any parent. |
Node | getChild(int position)
Throws IndexOutOfBoundsException because
comments do not have children. |
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 Comment object
to the specified string. |
String | toString()
Returns a string form of the comment suitable for debugging and diagnosis. |
String | toXML()
Returns a String containing the actual XML
form of the comment;
for example, <--This is a comment--> . |
Methods inherited from class nu.xom.Node |
detach, equals, getBaseURI, getDocument, getParent, hashCode |
Methods inherited from class Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public Comment(String data)
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.
data
- the initial text of the comment
public Comment(Comment comment)
Creates a new comment that's a copy of its argument. The copy has the same data but no parent node.
comment
- the comment to copyMethod Detail |
public final String getValue()
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 -->
.
getValue
in class Node
public void setValue(String data)
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.
data
- the text to install in the comment
public final Node getChild(int position)
Throws IndexOutOfBoundsException
because
comments do not have children.
getChild
in class Node
position
- the index of the child node to return
IndexOutOfBoundsException
- because comments
do not have children
public final int getChildCount()
Returns 0 because comments do not have children.
getChildCount
in class Node
public Node 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.
copy
in class Node
Comment
that is not part of a document
public final String toXML()
Returns a String
containing the actual XML
form of the comment;
for example, <--This is a comment-->
.
toXML
in class Node
String
containing a well-formed
XML comment
public final String toString()
Returns a string form of the comment suitable for debugging and diagnosis. It deliberately does not return an actual XML comment.
Comment
as a String
| |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |