javax.xml.soap
Interface Node
- org.w3c.dom.Node
- Detail, DetailEntry, SOAPBody, SOAPBodyElement, SOAPElement, SOAPEnvelope, SOAPFault, SOAPFaultElement, SOAPHeader, SOAPHeaderElement, Text
public interface Node
extends org.w3c.dom.Node
A representation of a node (element) in a DOM representation of an XML document
that provides some tree manipulation methods.
This interface provides methods for getting the value of a node, for
getting and setting the parent of a node, and for removing a node.
abstract void | detachNode() - Removes this
Node object from the tree.
|
abstract SOAPElement | getParentElement() - Returns the parent element of this
Node object.
|
abstract String | getValue() - Returns the the value of the immediate child of this
Node
object if a child exists and its value is text.
|
abstract 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.
|
abstract void | setParentElement(SOAPElement parent) - Sets the parent of this
Node object to the given
SOAPElement object.
|
abstract 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.
|
detachNode
public abstract void detachNode()
Removes this Node
object from the tree. Once
removed, this node can be garbage collected if there are no
application references to it.
getParentElement
public abstract SOAPElement getParentElement()
Returns the parent element of this Node
object.
This method can throw an UnsupportedOperationException
if the tree is not kept in memory.
- the
SOAPElement
object that is the parent of
this Node
object or null
if this
Node
object is root
getValue
public abstract String getValue()
Returns the the value of the immediate child of this Node
object if a child exists and its value is text.
- a
String
with the text of the immediate child of
this Node
object if (1) there is a child and
(2) the child is a Text
object;
null
otherwise
recycleNode
public abstract 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.
setParentElement
public abstract void setParentElement(SOAPElement parent)
throws SOAPException
Sets the parent of this Node
object to the given
SOAPElement
object.
parent
- the SOAPElement
object to be set as
the parent of this Node
object
SOAPException
- if there is a problem in setting the
parent to the given element
setValue
public abstract 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.