Class Comment

java.lang.Object
org.exolab.adaptx.xpath.XPathNode
org.exolab.adaptx.xslt.dom.Comment
All Implemented Interfaces:
Serializable

public class Comment extends XPathNode
A class representing a Comment node
Version:
$Revision: 3741 $ $Date: 2003-05-13 10:02:34 +0200 (Tue, 13 May 2003) $
Author:
Keith Visco
See Also:
  • Field Details

  • Constructor Details

    • Comment

      public Comment()
      Creates a new empty Comment
    • Comment

      public Comment(String value)
      Creates a new Comment with the given message
      Parameters:
      value - the text value of this Comment
  • Method Details

    • getNodeType

      public int getNodeType()
      Returns the type of this node.
      Returns:
      The type of this node
    • getStringValue

      public String getStringValue()
      Returns the string value of the node. The string value of a text node or an attribute node is it's text value. The string value of an element or a root node is the concatenation of the string value of all its child nodes. The string value of a namespace node is its namespace URI. The string value of a processing instruction is the instruction, and the string value of a comment is the comment text.
      Returns:
      The string value of the node
    • setValue

      public void setValue(String value)
      Sets the value for this XPathNode
    • getFirstChild

      public XPathNode getFirstChild()
      Returns the first child node of this node, or null if the node has no children. Child nodes are only returned for an element or root node.
      Specified by:
      getFirstChild in class XPathNode
      Returns:
      The first child node of this node, or null
    • hasChildNodes

      public boolean hasChildNodes()
      Returns true if this node has any child nodes.
      Specified by:
      hasChildNodes in class XPathNode
      Returns:
      True if this node has any child nodes.
    • getNext

      public XPathNode getNext()
      Returns the next sibling node in document order, or null if this node is the last node. This method is value for any node except the root node.
      Specified by:
      getNext in class XPathNode
      Returns:
      The next sibling node in document order, or null
    • getPrevious

      public XPathNode getPrevious()
      Returns the previous sibling node in document order, or null if this node is the first node. This method can is valid for any node except the root node.
      Specified by:
      getPrevious in class XPathNode
      Returns:
      The previous sibling node in document order, or null
    • getFirstAttribute

      public XPathNode getFirstAttribute()
      Returns the first in a list of attribute nodes, or null if the node has no attributes. This method is valid only for the element node.
      Specified by:
      getFirstAttribute in class XPathNode
      Returns:
      The first in a list of attribute nodes, or null
    • getAttribute

      public String getAttribute(String uri, String local)
      Returns the value of the named attribute, or null if the node has no such attribute. If the argument uri is null, the node's namespace URI will be used. This method is valid only for the element node.
      Specified by:
      getAttribute in class XPathNode
      Parameters:
      uri - The attribute's namespace URI, or null
      local - The attribute's local name
      Returns:
      The attribute's value, or null if no such attribute exists
    • getFirstNamespace

      public XPathNode getFirstNamespace()
      Returns the first in a list of namespace nodes, or null if the node has no namespaces. This method is valid only for the element node.
      Specified by:
      getFirstNamespace in class XPathNode
      Returns:
      The first in a list of namespace nodes, or null
    • getLocalName

      public String getLocalName()
      Returns the local name of the node. Returns the local name of an element or attribute, the prefix of a namespace node, the target of a processing instruction, or null for all other node types.
      Specified by:
      getLocalName in class XPathNode
      Returns:
      The local name of the node, or null if the node has no name
    • getNamespaceURI

      public String getNamespaceURI()
      Returns the namespace URI the node. Returns the namespace URI of an element, attribute or namespace node, or null for all other node types.
      Specified by:
      getNamespaceURI in class XPathNode
      Returns:
      The namespace URI of the node, or null if the node has no namespace URI
    • getParentNode

      public XPathNode getParentNode()
      Returns the parent node, or null if the node has no parent. This method is valid on all node types except the root node. Attribute and namespace nodes have the element as their parent node.
      Specified by:
      getParentNode in class XPathNode
      Returns:
      The parent node, or null
    • getProperty

      public Object getProperty(String name)
      Retrieves the property with the given name. This method, in conjuction with #setProperty, allows for a convenient way to store information that doesn't have it's own accessor methods.
      Parameters:
      name - the name of the property to return.
      See Also:
    • getRootNode

      public XPathNode getRootNode()
      Returns the root node.
      Specified by:
      getRootNode in class XPathNode
      Returns:
      The root node
    • getNamespaceURI

      public String getNamespaceURI(String prefix)
      Returns the namespace URI associated with this namespace prefix, as defined in the context of this node. Returns null if the prefix is undefined. Returns empty if the prefix is defined and associated with no namespace. This method is valid only for element nodes.
      Specified by:
      getNamespaceURI in class XPathNode
      Parameters:
      prefix - The namespace prefix
      Returns:
      The namespace URI, or null
    • getNamespacePrefix

      public String getNamespacePrefix(String uri)
      Returns the namespace prefix associated with this namespace URI, as defined in the context of this node. Returns null if no prefix is defined for this namespace URI. Returns an empty string if the default prefix is associated with this namespace URI. This method is valid only for element nodes.
      Specified by:
      getNamespacePrefix in class XPathNode
      Parameters:
      uri - The namespace URI
      Returns:
      The namespace prefix, or null
    • setProperty

      public void setProperty(String name, Object obj)
      Retrieves the property with the given name. This method, in conjuction with #setProperty, allows for a convenient way to store information that doesn't have it's own accessor methods.
      Parameters:
      name - the name of the property to return.
      See Also: