net.sf.saxon.sapling

Class SaplingComment

java.lang.Object

net.sf.saxon.sapling.SaplingNode

net.sf.saxon.sapling.SaplingComment

public class SaplingComment
extends SaplingNode

A comment node in a sapling tree

Constructor Summary

Constructors

Constructor and Description
SaplingComment(java.lang.String value) Construct a sapling comment node with a given string value

Method Summary

Modifier and Type	Method and Description
void	deliver(Receiver receiver, ParseOptions options) Send a sequence of events representing this node to a supplied Receiver
int	getNodeKind() Get the kind of node (document, element, text, comment, or processing instruction)
java.lang.String	getStringValue() Get the string value of the comment node

Methods inherited from class net.sf.saxon.sapling.SaplingNode

emptyNodeList

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SaplingComment

public SaplingComment(java.lang.String value)

Construct a sapling comment node with a given string value

Parameters:

value - the string value of the comment node. This should not contain "--" as a substring, but this condition is not checked.

Throws:

java.lang.NullPointerException - if the supplied value is null.

Method Detail

getNodeKind

public int getNodeKind()

Description copied from class: SaplingNode

Get the kind of node (document, element, text, comment, or processing instruction)

Specified by:

getNodeKind in class SaplingNode

Returns:

the kind of node, for example Type.ELEMENT for an element node.

getStringValue

public java.lang.String getStringValue()

Get the string value of the comment node

Returns:

the string value of the node

deliver

public void deliver(Receiver receiver,
                    ParseOptions options)
             throws XPathException

Description copied from class: SaplingNode

Send a sequence of events representing this node to a supplied Receiver

Specified by:

deliver in class SaplingNode

Parameters:

receiver - the receiver to which the events are to be sent

options - parse options (currently ignored)

Throws:

XPathException - if the receiver throws an exception