Top Description Fields Methods
jakarta.xml.soap

public Interface Node

extends Node
Known Direct Subinterfaces
jakarta.xml.soap.SOAPElement, jakarta.xml.soap.Text
Known Direct Implementers
jakarta.xml.soap.SOAPPart
A representation of a node (element) in an XML document. This interface extends 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.
Since
1.6

Field Summary

Inherited from org.w3c.dom.Node:
ATTRIBUTE_NODECDATA_SECTION_NODECOMMENT_NODEDOCUMENT_FRAGMENT_NODEDOCUMENT_NODEDOCUMENT_POSITION_CONTAINED_BYDOCUMENT_POSITION_CONTAINSDOCUMENT_POSITION_DISCONNECTEDDOCUMENT_POSITION_FOLLOWINGDOCUMENT_POSITION_IMPLEMENTATION_SPECIFICDOCUMENT_POSITION_PRECEDINGDOCUMENT_TYPE_NODEELEMENT_NODEENTITY_NODEENTITY_REFERENCE_NODENOTATION_NODEPROCESSING_INSTRUCTION_NODETEXT_NODE

Method Summary

Modifier and TypeMethod and Description
public void
detachNode()

Removes this Node object from the tree.

public SOAPElement

Returns:

the SOAPElement object that is the parent of this Node object or null if this Node object is root
getParentElement()

Returns the parent element of this Node object.

public String

Returns:

a String with the text of this node if this is a Text 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.
getValue()

Returns the value of this node if this is a Text node or the value of the immediate child of this node otherwise.

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
the SOAPElement object to be set as the parent of this Node object
parent)

Sets the parent of this Node object to the given SOAPElement object.

public void
setValue(String
value to set on the Text node
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.

Inherited from org.w3c.dom.Node:
appendChildcloneNodecompareDocumentPositiongetAttributesgetBaseURIgetChildNodesgetFeaturegetFirstChildgetLastChildgetLocalNamegetNamespaceURIgetNextSiblinggetNodeNamegetNodeTypegetNodeValuegetOwnerDocumentgetParentNodegetPrefixgetPreviousSiblinggetTextContentgetUserDatahasAttributeshasChildNodesinsertBeforeisDefaultNamespaceisEqualNodeisSameNodeisSupportedlookupNamespaceURIlookupPrefixnormalizeremoveChildreplaceChildsetNodeValuesetPrefixsetTextContentsetUserData

Method Detail

detachNodeback to summary
public void detachNode()

Removes this Node object from the tree.

getParentElementback to summary
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.

Returns:SOAPElement

the SOAPElement object that is the parent of this Node object or null if this Node object is root

Exceptions
UnsupportedOperationException:
if the whole tree is not kept in memory
See Also
setParentElement
getValueback to summary
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.

Returns:String

a String with the text of this node if this is a Text 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.

recycleNodeback to summary
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.

setParentElementback to summary
public void setParentElement(SOAPElement parent) throws SOAPException

Sets the parent of this Node object to the given SOAPElement object.

Parameters
parent:SOAPElement

the SOAPElement object to be set as the parent of this Node object

Exceptions
SOAPException:
if there is a problem in setting the parent to the given element
See Also
getParentElement
setValueback to summary
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.

Parameters
value:String

value to set on the Text node

Exceptions
IllegalStateException:
if the node is not a Text node and either has more than one child node or has a child node that is not a Text node.
Since
1.6, SAAJ 1.2