javax.xml.soap
Interface Node
-
- All Superinterfaces:
- Node
- All Known Subinterfaces:
- Detail, DetailEntry, SOAPBody, SOAPBodyElement, SOAPElement, SOAPEnvelope, SOAPFault, SOAPFaultElement, SOAPHeader, SOAPHeaderElement, Text
public interface Node extends Node
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.
-
-
Field Summary
-
Fields inherited from interface org.w3c.dom.Node
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description voiddetachNode()Removes thisNodeobject from the tree.SOAPElementgetParentElement()Returns the parent element of thisNodeobject.StringgetValue()Returns the value of this node if this is aTextnode or the value of the immediate child of this node otherwise.voidrecycleNode()Notifies the implementation that thisNodeobject 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.voidsetParentElement(SOAPElement parent)Sets the parent of thisNodeobject to the givenSOAPElementobject.voidsetValue(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.-
Methods inherited from interface org.w3c.dom.Node
appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData
-
-
-
-
Method Detail
getValue
String getValue()
Returns the value of this node if this is aTextnode or the value of the immediate child of this node otherwise. If there is an immediate child of thisNodethat it is aTextnode then it's value will be returned. If there is more than oneTextnode then the value of the firstTextNode will be returned. Otherwisenullis returned.- Returns:
-
a
Stringwith the text of this node if this is aTextnode or the text contained by the first immediate child of thisNodeobject that is aTextobject if such a child exists;nullotherwise.
setValue
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 aTextnode, or if there are no children in which case a childTextnode will be created.- Throws:
-
IllegalStateException- if the node is not aTextnode and either has more than one child node or has a child node that is not aTextnode. - Since:
- SAAJ 1.2
setParentElement
void setParentElement(SOAPElement parent) throws SOAPException
Sets the parent of thisNodeobject to the givenSOAPElementobject.- Parameters:
-
parent- theSOAPElementobject to be set as the parent of thisNodeobject - Throws:
-
SOAPException- if there is a problem in setting the parent to the given element - See Also:
-
getParentElement()
getParentElement
SOAPElement getParentElement()
Returns the parent element of thisNodeobject. This method can throw anUnsupportedOperationExceptionif the tree is not kept in memory.- Returns:
-
the
SOAPElementobject that is the parent of thisNodeobject ornullif thisNodeobject is root - Throws:
-
UnsupportedOperationException- if the whole tree is not kept in memory - See Also:
-
setParentElement(javax.xml.soap.SOAPElement)
detachNode
void detachNode()
Removes thisNodeobject from the tree.
recycleNode
void recycleNode()
Notifies the implementation that thisNodeobject 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
recycleNodeimplies that the methoddetachNodehas been called previously.
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
