Home » xml-commons-external-1.4.01-src » javax » xml » soap » [javadoc | source]
public interface: Node [javadoc | source]

All Implemented Interfaces:

All Known Implementing Classes:
    SOAPBodyElement, SOAPBody, SOAPHeaderElement, DetailEntry, SOAPEnvelope, SOAPFault, SOAPFaultElement, Detail, SOAPPart, Text, SOAPElement, SOAPHeader

A representation of a node (element) in an XML document. This interface extnends the standard DOM Node interface with methods for getting and setting the value of a node, for getting and setting the parent of a node, and for removing a node.
Method from javax.xml.soap.Node Summary:
detachNode,   getParentElement,   getValue,   recycleNode,   setParentElement,   setValue
Method from javax.xml.soap.Node Detail:
 public  void detachNode()
    Removes this Node object from the tree.
 public SOAPElement getParentElement()
    Returns the parent element of this Node object. This method can throw an UnsupportedOperationException if the tree is not kept in memory.
 public String getValue()
    Returns the value of this node if this is a Text node or the value of the immediate child of this node otherwise. If there is an immediate child of this Node that it is a Text node then it's value will be returned. If there is more than one Text node then the value of the first Text Node will be returned. Otherwise null is returned.
 public  void recycleNode()
    Notifies the implementation that this Node object is no longer being used by the application and that the implementation is free to reuse this object for nodes that may be created later.

    Calling the method recycleNode implies that the method detachNode has been called previously.

 public  void setParentElement(SOAPElement parent) throws SOAPException
    Sets the parent of this Node object to the given SOAPElement object.
 public  void setValue(String value)
    If this is a Text node then this method will set its value, otherwise it sets the value of the immediate (Text) child of this node. The value of the immediate child of this node can be set only if, there is one child node and that node is a Text node, or if there are no children in which case a child Text node will be created.