diff -r b5e266a4356c -r b80b84e87032 jaxws/src/java.xml.soap/share/classes/javax/xml/soap/Detail.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/jaxws/src/java.xml.soap/share/classes/javax/xml/soap/Detail.java Sun Aug 17 15:52:15 2014 +0100 @@ -0,0 +1,101 @@ +/* + * Copyright (c) 2004, 2013, 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; + +import java.util.Iterator; + +import javax.xml.namespace.QName; + +/** + * A container for DetailEntry objects. DetailEntry + * objects give detailed error information that is application-specific and + * related to the SOAPBody object that contains it. + *

+ * A Detail object, which is part of a SOAPFault + * object, can be retrieved using the method SOAPFault.getDetail. + * The Detail interface provides two methods. One creates a new + * DetailEntry object and also automatically adds it to + * the Detail object. The second method gets a list of the + * DetailEntry objects contained in a Detail + * object. + *

+ * The following code fragment, in which sf is a SOAPFault + * object, gets its Detail object (d), adds a new + * DetailEntry object to d, and then gets a list of all the + * DetailEntry objects in d. The code also creates a + * Name object to pass to the method addDetailEntry. + * The variable se, used to create the Name object, + * is a SOAPEnvelope object. + *

+ *    Detail d = sf.getDetail();
+ *    Name name = se.createName("GetLastTradePrice", "WOMBAT",
+ *                                "http://www.wombat.org/trader");
+ *    d.addDetailEntry(name);
+ *    Iterator it = d.getDetailEntries();
+ * 
+ * + * @since 1.6 + */ +public interface Detail extends SOAPFaultElement { + + /** + * Creates a new DetailEntry object with the given + * name and adds it to this Detail object. + * + * @param name a Name object identifying the + * new DetailEntry object + * + * @exception SOAPException thrown when there is a problem in adding a + * DetailEntry object to this Detail object. + * + * @see Detail#addDetailEntry(QName qname) + */ + public DetailEntry addDetailEntry(Name name) throws SOAPException; + + /** + * Creates a new DetailEntry object with the given + * QName and adds it to this Detail object. This method + * is the preferred over the one using Name. + * + * @param qname a QName object identifying the + * new DetailEntry object + * + * @exception SOAPException thrown when there is a problem in adding a + * DetailEntry object to this Detail object. + * + * @see Detail#addDetailEntry(Name name) + * @since 1.6, SAAJ 1.3 + */ + public DetailEntry addDetailEntry(QName qname) throws SOAPException; + + /** + * Gets an Iterator over all of the DetailEntrys in this Detail object. + * + * @return an Iterator object over the DetailEntry + * objects in this Detail object + */ + public Iterator getDetailEntries(); +}