Node (Java Platform SE 8 ) (original) (raw)

• 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](../../../org/w3c/dom/Node.html "interface in org.w3c.dom")  
     `[ATTRIBUTE_NODE](../../../org/w3c/dom/Node.html#ATTRIBUTE%5FNODE), [CDATA_SECTION_NODE](../../../org/w3c/dom/Node.html#CDATA%5FSECTION%5FNODE), [COMMENT_NODE](../../../org/w3c/dom/Node.html#COMMENT%5FNODE), [DOCUMENT_FRAGMENT_NODE](../../../org/w3c/dom/Node.html#DOCUMENT%5FFRAGMENT%5FNODE), [DOCUMENT_NODE](../../../org/w3c/dom/Node.html#DOCUMENT%5FNODE), [DOCUMENT_POSITION_CONTAINED_BY](../../../org/w3c/dom/Node.html#DOCUMENT%5FPOSITION%5FCONTAINED%5FBY), [DOCUMENT_POSITION_CONTAINS](../../../org/w3c/dom/Node.html#DOCUMENT%5FPOSITION%5FCONTAINS), [DOCUMENT_POSITION_DISCONNECTED](../../../org/w3c/dom/Node.html#DOCUMENT%5FPOSITION%5FDISCONNECTED), [DOCUMENT_POSITION_FOLLOWING](../../../org/w3c/dom/Node.html#DOCUMENT%5FPOSITION%5FFOLLOWING), [DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC](../../../org/w3c/dom/Node.html#DOCUMENT%5FPOSITION%5FIMPLEMENTATION%5FSPECIFIC), [DOCUMENT_POSITION_PRECEDING](../../../org/w3c/dom/Node.html#DOCUMENT%5FPOSITION%5FPRECEDING), [DOCUMENT_TYPE_NODE](../../../org/w3c/dom/Node.html#DOCUMENT%5FTYPE%5FNODE), [ELEMENT_NODE](../../../org/w3c/dom/Node.html#ELEMENT%5FNODE), [ENTITY_NODE](../../../org/w3c/dom/Node.html#ENTITY%5FNODE), [ENTITY_REFERENCE_NODE](../../../org/w3c/dom/Node.html#ENTITY%5FREFERENCE%5FNODE), [NOTATION_NODE](../../../org/w3c/dom/Node.html#NOTATION%5FNODE), [PROCESSING_INSTRUCTION_NODE](../../../org/w3c/dom/Node.html#PROCESSING%5FINSTRUCTION%5FNODE), [TEXT_NODE](../../../org/w3c/dom/Node.html#TEXT%5FNODE)`  

  • Method Summary

  All Methods Instance Methods Abstract Methods

  Modifier and Type	Method	Description
  void	detachNode()	Removes this Node object from the tree.
  SOAPElement	getParentElement()	Returns the parent element of this Node object.
  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.
  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.
  void	setParentElement(SOAPElement parent)	Sets the parent of this Node object to the givenSOAPElement object.
  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.

     * ### Methods inherited from interface org.w3c.dom.[Node](../../../org/w3c/dom/Node.html "interface in org.w3c.dom")  
     `[appendChild](../../../org/w3c/dom/Node.html#appendChild-org.w3c.dom.Node-), [cloneNode](../../../org/w3c/dom/Node.html#cloneNode-boolean-), [compareDocumentPosition](../../../org/w3c/dom/Node.html#compareDocumentPosition-org.w3c.dom.Node-), [getAttributes](../../../org/w3c/dom/Node.html#getAttributes--), [getBaseURI](../../../org/w3c/dom/Node.html#getBaseURI--), [getChildNodes](../../../org/w3c/dom/Node.html#getChildNodes--), [getFeature](../../../org/w3c/dom/Node.html#getFeature-java.lang.String-java.lang.String-), [getFirstChild](../../../org/w3c/dom/Node.html#getFirstChild--), [getLastChild](../../../org/w3c/dom/Node.html#getLastChild--), [getLocalName](../../../org/w3c/dom/Node.html#getLocalName--), [getNamespaceURI](../../../org/w3c/dom/Node.html#getNamespaceURI--), [getNextSibling](../../../org/w3c/dom/Node.html#getNextSibling--), [getNodeName](../../../org/w3c/dom/Node.html#getNodeName--), [getNodeType](../../../org/w3c/dom/Node.html#getNodeType--), [getNodeValue](../../../org/w3c/dom/Node.html#getNodeValue--), [getOwnerDocument](../../../org/w3c/dom/Node.html#getOwnerDocument--), [getParentNode](../../../org/w3c/dom/Node.html#getParentNode--), [getPrefix](../../../org/w3c/dom/Node.html#getPrefix--), [getPreviousSibling](../../../org/w3c/dom/Node.html#getPreviousSibling--), [getTextContent](../../../org/w3c/dom/Node.html#getTextContent--), [getUserData](../../../org/w3c/dom/Node.html#getUserData-java.lang.String-), [hasAttributes](../../../org/w3c/dom/Node.html#hasAttributes--), [hasChildNodes](../../../org/w3c/dom/Node.html#hasChildNodes--), [insertBefore](../../../org/w3c/dom/Node.html#insertBefore-org.w3c.dom.Node-org.w3c.dom.Node-), [isDefaultNamespace](../../../org/w3c/dom/Node.html#isDefaultNamespace-java.lang.String-), [isEqualNode](../../../org/w3c/dom/Node.html#isEqualNode-org.w3c.dom.Node-), [isSameNode](../../../org/w3c/dom/Node.html#isSameNode-org.w3c.dom.Node-), [isSupported](../../../org/w3c/dom/Node.html#isSupported-java.lang.String-java.lang.String-), [lookupNamespaceURI](../../../org/w3c/dom/Node.html#lookupNamespaceURI-java.lang.String-), [lookupPrefix](../../../org/w3c/dom/Node.html#lookupPrefix-java.lang.String-), [normalize](../../../org/w3c/dom/Node.html#normalize--), [removeChild](../../../org/w3c/dom/Node.html#removeChild-org.w3c.dom.Node-), [replaceChild](../../../org/w3c/dom/Node.html#replaceChild-org.w3c.dom.Node-org.w3c.dom.Node-), [setNodeValue](../../../org/w3c/dom/Node.html#setNodeValue-java.lang.String-), [setPrefix](../../../org/w3c/dom/Node.html#setPrefix-java.lang.String-), [setTextContent](../../../org/w3c/dom/Node.html#setTextContent-java.lang.String-), [setUserData](../../../org/w3c/dom/Node.html#setUserData-java.lang.String-java.lang.Object-org.w3c.dom.UserDataHandler-)`

• • Method Detail

     * #### getValue  
     [String](../../../java/lang/String.html "class in java.lang") 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:  
     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.  
     * #### setValue  
     void setValue([String](../../../java/lang/String.html "class in java.lang") 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.  
     Throws:  
     `[IllegalStateException](../../../java/lang/IllegalStateException.html "class in java.lang")` \- 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:  
     SAAJ 1.2  
     * #### setParentElement  
     void setParentElement([SOAPElement](../../../javax/xml/soap/SOAPElement.html "interface in javax.xml.soap") parent)  
                    throws [SOAPException](../../../javax/xml/soap/SOAPException.html "class in javax.xml.soap")  
     Sets the parent of this `Node` object to the given`SOAPElement` object.  
     Parameters:  
     `parent` \- the `SOAPElement` object to be set as the parent of this `Node` object  
     Throws:  
     `[SOAPException](../../../javax/xml/soap/SOAPException.html "class in javax.xml.soap")` \- if there is a problem in setting the parent to the given element  
     See Also:  
     [getParentElement()](../../../javax/xml/soap/Node.html#getParentElement--)  
     * #### getParentElement  
     [SOAPElement](../../../javax/xml/soap/SOAPElement.html "interface in javax.xml.soap") getParentElement()  
     Returns the parent element of this `Node` object. This method can throw an `UnsupportedOperationException` if the tree is not kept in memory.  
     Returns:  
     the `SOAPElement` object that is the parent of this `Node` object or `null` if this`Node` object is root  
     Throws:  
     `[UnsupportedOperationException](../../../java/lang/UnsupportedOperationException.html "class in java.lang")` \- if the whole tree is not kept in memory  
     See Also:  
     [setParentElement(javax.xml.soap.SOAPElement)](../../../javax/xml/soap/Node.html#setParentElement-javax.xml.soap.SOAPElement-)  
     * #### detachNode  
     void detachNode()  
     Removes this `Node` object from the tree.  
     * #### recycleNode  
     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.

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, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.