diff -r 88b85470e72c -r f50545b5e2f1 src/share/jaxws_classes/javax/xml/soap/Node.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/share/jaxws_classes/javax/xml/soap/Node.java Tue Mar 06 16:09:35 2012 -0800 @@ -0,0 +1,112 @@ +/* + * Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +package javax.xml.soap; + +/** + * 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. + */ +public interface Node extends org.w3c.dom.Node { + /** + * 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. + * + * @return 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. + */ + public String getValue(); + + /** + * 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 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 + */ + public void setValue(String value); + + /** + * Sets the parent of this Node object to the given + * SOAPElement object. + * + * @param parent the SOAPElement object to be set as + * the parent of this Node object + * + * @exception SOAPException if there is a problem in setting the + * parent to the given element + * @see #getParentElement + */ + public void setParentElement(SOAPElement parent) throws SOAPException; + + /** + * Returns the parent element of this Node object. + * This method can throw an UnsupportedOperationException + * if the tree is not kept in memory. + * + * @return the SOAPElement object that is the parent of + * this Node object or null if this + * Node object is root + * + * @exception UnsupportedOperationException if the whole tree is not + * kept in memory + * @see #setParentElement + */ + public SOAPElement getParentElement(); + + /** + * Removes this Node object from the tree. + */ + public void detachNode(); + + /** + * 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. + */ + public void recycleNode(); + +}