| javax.xml.soap.Node
All known Subclasses: javax.xml.soap.SOAPPart,
| Node | | public interface Node extends org.w3c.dom.Node(Code) | | 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 Summary | |
| public void | detachNode()
Removes this Node object from the tree. | | public SOAPElement | getParentElement()
Returns the parent element of this Node object. | | 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. | | 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. | | public void | setParentElement(SOAPElement parent)
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. |
| detachNode | | public void detachNode()(Code) | | Removes this Node object from the tree.
|
| getParentElement | | public SOAPElement getParentElement()(Code) | | 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 ofthis Node object or null if thisNode object is root
exception:
UnsupportedOperationException - if the whole tree is notkept in memory
See Also: Node.setParentElement |
| getValue | | public String getValue()(Code) | | 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.
a String with the text of this node if this is aText node or the text contained by the first immediate child of this Node object that is a Text object if such a child exists;null otherwise. |
| recycleNode | | public void recycleNode()(Code) | | 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 void setParentElement(SOAPElement parent) throws SOAPException(Code) | | Sets the parent of this Node object to the given
SOAPElement object.
Parameters:
parent - the SOAPElement object to be set asthe parent of this Node object
exception:
SOAPException - if there is a problem in setting theparent to the given element
See Also: Node.getParentElement |
| setValue | | public void setValue(String value)(Code) | | 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.
exception:
IllegalStateException - if the node is not a Textnode and either has more than one child node or has a child node that is not a Text node.
since:
SAAJ 1.2 |
|
|