Mercurial > jdk8-mips64-public > jaxws / annotate
src/share/jaxws_classes/javax/xml/soap/Detail.java@7166269ef0f1 (annotated)
src/share/jaxws_classes/javax/xml/soap/Detail.java
Sat, 07 Nov 2020 10:30:02 +0800
- author
- aoqi
- date
- Sat, 07 Nov 2020 10:30:02 +0800
- changeset 1921
- 7166269ef0f1
- parent 637
- 9c07ef4934dd
- permissions
- -rw-r--r--
Added tag mips-jdk8u275-b01 for changeset fdbe50121f48
| aoqi@0 | 1 | /* |
| aoqi@0 | 2 | * Copyright (c) 2004, 2012, Oracle and/or its affiliates. All rights reserved. |
| aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| aoqi@0 | 4 | * |
| aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
| aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
| aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
| aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| aoqi@0 | 10 | * |
| aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| aoqi@0 | 15 | * accompanied this code). |
| aoqi@0 | 16 | * |
| aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
| aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| aoqi@0 | 20 | * |
| aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
| aoqi@0 | 23 | * questions. |
| aoqi@0 | 24 | */ |
| aoqi@0 | 25 | |
| aoqi@0 | 26 | package javax.xml.soap; |
| aoqi@0 | 27 | |
| aoqi@0 | 28 | import java.util.Iterator; |
| aoqi@0 | 29 | |
| aoqi@0 | 30 | import javax.xml.namespace.QName; |
| aoqi@0 | 31 | |
| aoqi@0 | 32 | /** |
| aoqi@0 | 33 | * A container for <code>DetailEntry</code> objects. <code>DetailEntry</code> |
| aoqi@0 | 34 | * objects give detailed error information that is application-specific and |
| aoqi@0 | 35 | * related to the <code>SOAPBody</code> object that contains it. |
| aoqi@0 | 36 | *<P> |
| aoqi@0 | 37 | * A <code>Detail</code> object, which is part of a <code>SOAPFault</code> |
| aoqi@0 | 38 | * object, can be retrieved using the method <code>SOAPFault.getDetail</code>. |
| aoqi@0 | 39 | * The <code>Detail</code> interface provides two methods. One creates a new |
| aoqi@0 | 40 | * <code>DetailEntry</code> object and also automatically adds it to |
| aoqi@0 | 41 | * the <code>Detail</code> object. The second method gets a list of the |
| aoqi@0 | 42 | * <code>DetailEntry</code> objects contained in a <code>Detail</code> |
| aoqi@0 | 43 | * object. |
| aoqi@0 | 44 | * <P> |
| aoqi@0 | 45 | * The following code fragment, in which <i>sf</i> is a <code>SOAPFault</code> |
| aoqi@0 | 46 | * object, gets its <code>Detail</code> object (<i>d</i>), adds a new |
| aoqi@0 | 47 | * <code>DetailEntry</code> object to <i>d</i>, and then gets a list of all the |
| aoqi@0 | 48 | * <code>DetailEntry</code> objects in <i>d</i>. The code also creates a |
| aoqi@0 | 49 | * <code>Name</code> object to pass to the method <code>addDetailEntry</code>. |
| aoqi@0 | 50 | * The variable <i>se</i>, used to create the <code>Name</code> object, |
| aoqi@0 | 51 | * is a <code>SOAPEnvelope</code> object. |
| aoqi@0 | 52 | * <PRE> |
| aoqi@0 | 53 | * Detail d = sf.getDetail(); |
| aoqi@0 | 54 | * Name name = se.createName("GetLastTradePrice", "WOMBAT", |
| aoqi@0 | 55 | * "http://www.wombat.org/trader"); |
| aoqi@0 | 56 | * d.addDetailEntry(name); |
| aoqi@0 | 57 | * Iterator it = d.getDetailEntries(); |
| aoqi@0 | 58 | * </PRE> |
| aoqi@0 | 59 | */ |
| aoqi@0 | 60 | public interface Detail extends SOAPFaultElement { |
| aoqi@0 | 61 | |
| aoqi@0 | 62 | /** |
| aoqi@0 | 63 | * Creates a new <code>DetailEntry</code> object with the given |
| aoqi@0 | 64 | * name and adds it to this <code>Detail</code> object. |
| aoqi@0 | 65 | * |
| aoqi@0 | 66 | * @param name a <code>Name</code> object identifying the |
| aoqi@0 | 67 | * new <code>DetailEntry</code> object |
| aoqi@0 | 68 | * |
| aoqi@0 | 69 | * @exception SOAPException thrown when there is a problem in adding a |
| aoqi@0 | 70 | * DetailEntry object to this Detail object. |
| aoqi@0 | 71 | * |
| aoqi@0 | 72 | * @see Detail#addDetailEntry(QName qname) |
| aoqi@0 | 73 | */ |
| aoqi@0 | 74 | public DetailEntry addDetailEntry(Name name) throws SOAPException; |
| aoqi@0 | 75 | |
| aoqi@0 | 76 | /** |
| aoqi@0 | 77 | * Creates a new <code>DetailEntry</code> object with the given |
| aoqi@0 | 78 | * QName and adds it to this <code>Detail</code> object. This method |
| aoqi@0 | 79 | * is the preferred over the one using Name. |
| aoqi@0 | 80 | * |
| aoqi@0 | 81 | * @param qname a <code>QName</code> object identifying the |
| aoqi@0 | 82 | * new <code>DetailEntry</code> object |
| aoqi@0 | 83 | * |
| aoqi@0 | 84 | * @exception SOAPException thrown when there is a problem in adding a |
| aoqi@0 | 85 | * DetailEntry object to this Detail object. |
| aoqi@0 | 86 | * |
| aoqi@0 | 87 | * @see Detail#addDetailEntry(Name name) |
| aoqi@0 | 88 | * @since SAAJ 1.3 |
| aoqi@0 | 89 | */ |
| aoqi@0 | 90 | public DetailEntry addDetailEntry(QName qname) throws SOAPException; |
| aoqi@0 | 91 | |
| aoqi@0 | 92 | /** |
| aoqi@0 | 93 | * Gets an Iterator over all of the <code>DetailEntry</code>s in this <code>Detail</code> object. |
| aoqi@0 | 94 | * |
| aoqi@0 | 95 | * @return an <code>Iterator</code> object over the <code>DetailEntry</code> |
| aoqi@0 | 96 | * objects in this <code>Detail</code> object |
| aoqi@0 | 97 | */ |
| aoqi@0 | 98 | public Iterator getDetailEntries(); |
| aoqi@0 | 99 | } |
