src/share/jaxws_classes/javax/xml/soap/Node.java

Tue, 06 Mar 2012 16:09:35 -0800

author
ohair
date
Tue, 06 Mar 2012 16:09:35 -0800
changeset 286
f50545b5e2f1
child 368
0989ad8c0860
permissions
-rw-r--r--

7150322: Stop using drop source bundles in jaxws
Reviewed-by: darcy, ohrstrom

ohair@286 1 /*
ohair@286 2 * Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved.
ohair@286 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286 4 *
ohair@286 5 * This code is free software; you can redistribute it and/or modify it
ohair@286 6 * under the terms of the GNU General Public License version 2 only, as
ohair@286 7 * published by the Free Software Foundation. Oracle designates this
ohair@286 8 * particular file as subject to the "Classpath" exception as provided
ohair@286 9 * by Oracle in the LICENSE file that accompanied this code.
ohair@286 10 *
ohair@286 11 * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
ohair@286 14 * version 2 for more details (a copy is included in the LICENSE file that
ohair@286 15 * accompanied this code).
ohair@286 16 *
ohair@286 17 * You should have received a copy of the GNU General Public License version
ohair@286 18 * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286 20 *
ohair@286 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286 22 * or visit www.oracle.com if you need additional information or have any
ohair@286 23 * questions.
ohair@286 24 */
ohair@286 25
ohair@286 26 package javax.xml.soap;
ohair@286 27
ohair@286 28 /**
ohair@286 29 * A representation of a node (element) in an XML document.
ohair@286 30 * This interface extnends the standard DOM Node interface with methods for
ohair@286 31 * getting and setting the value of a node, for
ohair@286 32 * getting and setting the parent of a node, and for removing a node.
ohair@286 33 */
ohair@286 34 public interface Node extends org.w3c.dom.Node {
ohair@286 35 /**
ohair@286 36 * Returns the value of this node if this is a <code>Text</code> node or the
ohair@286 37 * value of the immediate child of this node otherwise.
ohair@286 38 * If there is an immediate child of this <code>Node</code> that it is a
ohair@286 39 * <code>Text</code> node then it's value will be returned. If there is
ohair@286 40 * more than one <code>Text</code> node then the value of the first
ohair@286 41 * <code>Text</code> Node will be returned.
ohair@286 42 * Otherwise <code>null</code> is returned.
ohair@286 43 *
ohair@286 44 * @return a <code>String</code> with the text of this node if this is a
ohair@286 45 * <code>Text</code> node or the text contained by the first
ohair@286 46 * immediate child of this <code>Node</code> object that is a
ohair@286 47 * <code>Text</code> object if such a child exists;
ohair@286 48 * <code>null</code> otherwise.
ohair@286 49 */
ohair@286 50 public String getValue();
ohair@286 51
ohair@286 52 /**
ohair@286 53 * If this is a Text node then this method will set its value,
ohair@286 54 * otherwise it sets the value of the immediate (Text) child of this node.
ohair@286 55 * The value of the immediate child of this node can be set only if, there is
ohair@286 56 * one child node and that node is a <code>Text</code> node, or if
ohair@286 57 * there are no children in which case a child <code>Text</code> node will be
ohair@286 58 * created.
ohair@286 59 *
ohair@286 60 * @exception IllegalStateException if the node is not a <code>Text</code>
ohair@286 61 * node and either has more than one child node or has a child
ohair@286 62 * node that is not a <code>Text</code> node.
ohair@286 63 *
ohair@286 64 * @since SAAJ 1.2
ohair@286 65 */
ohair@286 66 public void setValue(String value);
ohair@286 67
ohair@286 68 /**
ohair@286 69 * Sets the parent of this <code>Node</code> object to the given
ohair@286 70 * <code>SOAPElement</code> object.
ohair@286 71 *
ohair@286 72 * @param parent the <code>SOAPElement</code> object to be set as
ohair@286 73 * the parent of this <code>Node</code> object
ohair@286 74 *
ohair@286 75 * @exception SOAPException if there is a problem in setting the
ohair@286 76 * parent to the given element
ohair@286 77 * @see #getParentElement
ohair@286 78 */
ohair@286 79 public void setParentElement(SOAPElement parent) throws SOAPException;
ohair@286 80
ohair@286 81 /**
ohair@286 82 * Returns the parent element of this <code>Node</code> object.
ohair@286 83 * This method can throw an <code>UnsupportedOperationException</code>
ohair@286 84 * if the tree is not kept in memory.
ohair@286 85 *
ohair@286 86 * @return the <code>SOAPElement</code> object that is the parent of
ohair@286 87 * this <code>Node</code> object or <code>null</code> if this
ohair@286 88 * <code>Node</code> object is root
ohair@286 89 *
ohair@286 90 * @exception UnsupportedOperationException if the whole tree is not
ohair@286 91 * kept in memory
ohair@286 92 * @see #setParentElement
ohair@286 93 */
ohair@286 94 public SOAPElement getParentElement();
ohair@286 95
ohair@286 96 /**
ohair@286 97 * Removes this <code>Node</code> object from the tree.
ohair@286 98 */
ohair@286 99 public void detachNode();
ohair@286 100
ohair@286 101 /**
ohair@286 102 * Notifies the implementation that this <code>Node</code>
ohair@286 103 * object is no longer being used by the application and that the
ohair@286 104 * implementation is free to reuse this object for nodes that may
ohair@286 105 * be created later.
ohair@286 106 * <P>
ohair@286 107 * Calling the method <code>recycleNode</code> implies that the method
ohair@286 108 * <code>detachNode</code> has been called previously.
ohair@286 109 */
ohair@286 110 public void recycleNode();
ohair@286 111
ohair@286 112 }

mercurial