You are viewing a plain text version of this content. The canonical link for it is here.
Posted to java-dev@axis.apache.org by di...@apache.org on 2002/06/17 00:19:51 UTC
cvs commit: xml-axis/java/src/javax/xml/rpc ParameterMode.java
dims 2002/06/16 15:19:50
Modified: java/src/javax/xml/soap AttachmentPart.java Detail.java
DetailEntry.java MimeHeaders.java Node.java
SOAPBody.java SOAPBodyElement.java
SOAPConnection.java SOAPConnectionFactory.java
SOAPElement.java SOAPElementFactory.java
SOAPFactory.java SOAPFault.java
SOAPFaultElement.java SOAPHeaderElement.java
SOAPPart.java
java/src/org/apache/axis/message MessageElement.java
java/src/javax/xml/rpc ParameterMode.java
Log:
Updated javadocs to SOAP with Attachments API for JavaTM (SAAJ) 1.1 @ http://java.sun.com/webservices/docs/1.0/api/index.html
Revision Changes Path
1.3 +25 -25 xml-axis/java/src/javax/xml/soap/AttachmentPart.java
Index: AttachmentPart.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/soap/AttachmentPart.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- AttachmentPart.java 16 Jun 2002 19:36:54 -0000 1.2
+++ AttachmentPart.java 16 Jun 2002 22:19:49 -0000 1.3
@@ -182,32 +182,32 @@
public abstract void clearContent();
/**
- * Gets the content of this <CODE>AttachmentPart</CODE> object
- * as a Java object. The type of the returned Java object
- * depends on (1) the <CODE>DataContentHandler</CODE> object
- * that is used to interpret the bytes and (2) the <CODE>
- * Content-Type</CODE> given in the header.
+ * Gets the content of this <code>AttachmentPart</code> object as a Java
+ * object. The type of the returned Java object depends on (1) the
+ * <code>DataContentHandler</code> object that is used to interpret the bytes
+ * and (2) the <code>Content-Type</code> given in the header.
+ * <p>
+ * For the MIME content types "text/plain", "text/html" and "text/xml", the
+ * <code>DataContentHandler</code> object does the conversions to and
+ * from the Java types corresponding to the MIME types.
+ * For other MIME types,the <code>DataContentHandler</code> object
+ * can return an <code>InputStream</code> object that contains the content data
+ * as raw bytes.
+ * <p>
+ * A JAXM-compliant implementation must, as a minimum, return a
+ * <code>java.lang.String</code> object corresponding to any content
+ * stream with a <code>Content-Type</code> value of
+ * <code>text/plain</code>, a
+ * <code>javax.xml.transform.StreamSource</code> object corresponding to a
+ * content stream with a <code>Content-Type</code> value of
+ * <code>text/xml</code>, a <code>java.awt.Image</code> object
+ * corresponding to a content stream with a
+ * <code>Content-Type</code> value of <code>image/gif</code> or
+ * <code>image/jpeg</code>. For those content types that an
+ * installed <code>DataContentHandler</code> object does not understand, the
+ * <code>DataContentHandler</code> object is required to return a
+ * <code>java.io.InputStream</code> object with the raw bytes.
*
- * <P>For the MIME content types "text/plain", "text/html" and
- * "text/xml", the <CODE>DataContentHandler</CODE> object does
- * the conversions to and from the Java types corresponding to
- * the MIME types. For other MIME types,the <CODE>
- * DataContentHandler</CODE> object can return an <CODE>
- * InputStream</CODE> object that contains the content data as
- * raw bytes.</P>
- *
- * <P>A JAXM-compliant implementation must, as a minimum,
- * return a <CODE>java.lang.String</CODE> object corresponding
- * to any content stream with a <CODE>Content-Type</CODE>
- * value of <CODE>text/plain</CODE> and a <CODE>
- * javax.xml.transform.StreamSource</CODE> object
- * corresponding to a content stream with a <CODE>
- * Content-Type</CODE> value of <CODE>text/xml</CODE>. For
- * those content types that an installed <CODE>
- * DataContentHandler</CODE> object does not understand, the
- * <CODE>DataContentHandler</CODE> object is required to
- * return a <CODE>java.io.InputStream</CODE> object with the
- * raw bytes.</P>
* @return a Java object with the content of this <CODE>
* AttachmentPart</CODE> object
* @throws SOAPException if there is no content set
1.3 +3 -3 xml-axis/java/src/javax/xml/soap/Detail.java
Index: Detail.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/soap/Detail.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- Detail.java 13 May 2002 13:11:33 -0000 1.2
+++ Detail.java 16 Jun 2002 22:19:49 -0000 1.3
@@ -61,15 +61,15 @@
* objects give detailed error information that is application-specific and
* related to the <code>SOAPBody</code> object that contains it.
* <P>
- * A <code>Detail</code> object, which is part of a <code>SOAPFaultException</code>
- * object, can be retrieved using the method <code>SOAPFaultException.getDetail</code>.
+ * A <code>Detail</code> object, which is part of a <code>SOAPFault</code>
+ * object, can be retrieved using the method <code>SOAPFault.getDetail</code>.
* The <code>Detail</code> interface provides two methods. One creates a new
* <code>DetailEntry</code> object and also automatically adds it to
* the <code>Detail</code> object. The second method gets a list of the
* <code>DetailEntry</code> objects contained in a <code>Detail</code>
* object.
* <P>
- * The following code fragment, in which <i>sf</i> is a <code>SOAPFaultException</code>
+ * The following code fragment, in which <i>sf</i> is a <code>SOAPFault</code>
* object, gets its <code>Detail</code> object (<i>d</i>), adds a new
* <code>DetailEntry</code> object to <i>d</i>, and then gets a list of all the
* <code>DetailEntry</code> objects in <i>d</i>. The code also creates a
1.3 +1 -1 xml-axis/java/src/javax/xml/soap/DetailEntry.java
Index: DetailEntry.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/soap/DetailEntry.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- DetailEntry.java 13 May 2002 13:11:33 -0000 1.2
+++ DetailEntry.java 16 Jun 2002 22:19:49 -0000 1.3
@@ -56,7 +56,7 @@
/**
* The content for a <code>Detail</code> object, giving details for
- * a <code>SOAPFaultException</code> object. A <code>DetailEntry</code> object,
+ * a <code>SOAPFault</code> object. A <code>DetailEntry</code> object,
* which carries information about errors related to the <code>SOAPBody</code>
* object that contains it, is application-specific.
* <P>
1.2 +3 -0 xml-axis/java/src/javax/xml/soap/MimeHeaders.java
Index: MimeHeaders.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/soap/MimeHeaders.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- MimeHeaders.java 25 Jan 2002 16:30:07 -0000 1.1
+++ MimeHeaders.java 16 Jun 2002 22:19:49 -0000 1.2
@@ -230,6 +230,9 @@
* @param value a <CODE>String</CODE> with the
* value that will replace the current value of the
* specified header
+ * @throws java.lang.IllegalArgumentException if there was a
+ * problem in the mime header name or the value being set
+ * @see #getHeader(java.lang.String) getHeader(java.lang.String)
*/
public void setHeader(String name, String value) {
1.2 +1 -0 xml-axis/java/src/javax/xml/soap/Node.java
Index: Node.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/soap/Node.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- Node.java 25 Jan 2002 16:30:07 -0000 1.1
+++ Node.java 16 Jun 2002 22:19:49 -0000 1.2
@@ -91,6 +91,7 @@
* @return the <code>SOAPElement</code> object that is the parent of
* this <code>Node</code> object or <code>null</code> if this
* <code>Node</code> object is root
+ * @throws java.lang.UnsupportedOperationException if the whole tree is not kept in memory
* @see #setParentElement(javax.xml.soap.SOAPElement) setParentElement(javax.xml.soap.SOAPElement)
*/
public abstract SOAPElement getParentElement();
1.3 +8 -8 xml-axis/java/src/javax/xml/soap/SOAPBody.java
Index: SOAPBody.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/soap/SOAPBody.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- SOAPBody.java 13 May 2002 13:11:33 -0000 1.2
+++ SOAPBody.java 16 Jun 2002 22:19:49 -0000 1.3
@@ -61,33 +61,33 @@
* <P>
* A <code>SOAPBody</code> object contains <code>SOAPBodyElement</code>
* objects, which have the content for the SOAP body.
- * A <code>SOAPFaultException</code> object, which carries status and/or
+ * A <code>SOAPFault</code> object, which carries status and/or
* error information, is an example of a <code>SOAPBodyElement</code> object.
- * @see javax.xml.rpc.soap.SOAPFaultException SOAPFaultException
+ * @see SOAPFault SOAPFault
*/
public interface SOAPBody extends SOAPElement {
/**
- * Creates a new <code>SOAPFaultException</code> object and adds it to
+ * Creates a new <code>SOAPFault</code> object and adds it to
* this <code>SOAPBody</code> object.
- * @return the new <code>SOAPFaultException</code> object
+ * @return the new <code>SOAPFault</code> object
* @throws SOAPException if there is a SOAP error
*/
public abstract SOAPFault addFault() throws SOAPException;
/**
- * Indicates whether a <code>SOAPFaultException</code> object exists in
+ * Indicates whether a <code>SOAPFault</code> object exists in
* this <code>SOAPBody</code> object.
- * @return <code>true</code> if a <code>SOAPFaultException</code> object exists in
+ * @return <code>true</code> if a <code>SOAPFault</code> object exists in
* this <code>SOAPBody</code> object; <code>false</code>
* otherwise
*/
public abstract boolean hasFault();
/**
- * Returns the <code>SOAPFaultException</code> object in this <code>SOAPBody</code>
+ * Returns the <code>SOAPFault</code> object in this <code>SOAPBody</code>
* object.
- * @return the <code>SOAPFaultException</code> object in this <code>SOAPBody</code>
+ * @return the <code>SOAPFault</code> object in this <code>SOAPBody</code>
* object
*/
public abstract SOAPFault getFault();
1.3 +1 -1 xml-axis/java/src/javax/xml/soap/SOAPBodyElement.java
Index: SOAPBodyElement.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/soap/SOAPBodyElement.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- SOAPBodyElement.java 13 May 2002 13:11:33 -0000 1.2
+++ SOAPBodyElement.java 16 Jun 2002 22:19:49 -0000 1.3
@@ -56,7 +56,7 @@
/**
* A <code>SOAPBodyElement</code> object represents the contents in
- * a <code>SOAPBody</code> object. The <code>SOAPFaultException</code> interface
+ * a <code>SOAPBody</code> object. The <code>SOAPFault</code> interface
* is a <code>SOAPBodyElement</code> object that has been defined.
* <P>
* A new <code>SOAPBodyElement</code> object can be created and added
1.4 +19 -19 xml-axis/java/src/javax/xml/soap/SOAPConnection.java
Index: SOAPConnection.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/soap/SOAPConnection.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- SOAPConnection.java 16 Jun 2002 19:36:54 -0000 1.3
+++ SOAPConnection.java 16 Jun 2002 22:19:49 -0000 1.4
@@ -55,22 +55,19 @@
package javax.xml.soap;
/**
- * <P>A point-to-point connection that a client can use for
- * sending messages directly to a remote party (represented by a
- * URL, for instance) without using a messaging provider. A
- * standalone client uses a <CODE>SOAPConnection</CODE> object
- * rather than a <CODE>ProviderConnection</CODE> object.</P>
+ * A point-to-point connection that a client can use for sending messages
+ * directly to a remote party (represented by a URL, for instance).
+ * <p>
+ * A client can obtain a <code>SOAPConnection</code> object simply by
+ * calling the following static method.
+ * <pre>
*
- * <P>A client can obtain a <CODE>SOAPConnection</CODE> object
- * simply by calling the following static method.</P>
- * <PRE>
- * SOAPConnection con = SOAPConnection.newInstance();
- * </PRE>
- * A <CODE>SOAPConnection</CODE> object can be used to send
- * messages directly to a URL following the request/response
- * paradigm. That is, messages are sent using the method <CODE>
- * call</CODE>, which sends the message and then waits until it
- * gets a reply.
+ * SOAPConnection con = SOAPConnection.newInstance();
+ * </pre>
+ * A <code>SOAPConnection</code> object can be used to send messages
+ * directly to a URL following the request/response paradigm. That is,
+ * messages are sent using the method <code>call</code>, which sends the
+ * message and then waits until it gets a reply.
*/
public abstract class SOAPConnection {
@@ -80,11 +77,14 @@
/**
* Sends the given message to the specified endpoint and
* blocks until it has returned the response.
- * @param request the <CODE>SOAPMessage</CODE>
+ * @param request the <CODE>SOAPMessage</CODE>
* object to be sent
- * @param endpoint a <CODE>URLEndpoint</CODE>
- * object giving the URL to which the message should be
- * sent
+ * @param an <code>Object</code> that identifies
+ * where the message should be sent. It is required to
+ * support Objects of type
+ * <code>java.lang.String</code>,
+ * <code>java.net.URL</code>, and when JAXM is present
+ * <code>javax.xml.messaging.URLEndpoint</code>
* @return the <CODE>SOAPMessage</CODE> object that is the
* response to the message that was sent
* @throws SOAPException if there is a SOAP error
1.6 +1 -1 xml-axis/java/src/javax/xml/soap/SOAPConnectionFactory.java
Index: SOAPConnectionFactory.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/soap/SOAPConnectionFactory.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- SOAPConnectionFactory.java 16 Jun 2002 19:36:54 -0000 1.5
+++ SOAPConnectionFactory.java 16 Jun 2002 22:19:49 -0000 1.6
@@ -67,7 +67,7 @@
* SOAPConnectionFactory</CODE> object
* @throws SOAPException if there was an error creating
* the <CODE>SOAPConnectionFactory
- * @throws UnsupportedOperationException
+ * @throws UnsupportedOperationException if newInstance is not supported.
*/
public static SOAPConnectionFactory newInstance()
throws SOAPException, UnsupportedOperationException {
1.3 +1 -1 xml-axis/java/src/javax/xml/soap/SOAPElement.java
Index: SOAPElement.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/soap/SOAPElement.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- SOAPElement.java 13 May 2002 13:11:33 -0000 1.2
+++ SOAPElement.java 16 Jun 2002 22:19:49 -0000 1.3
@@ -61,7 +61,7 @@
* <code>SOAPBody</code> object, the contents in a <code>SOAPHeader</code>
* object, the content that can follow the <code>SOAPBody</code> object in a
* <code>SOAPEnvelope</code> object, or what can follow the detail element
- * in a <code>SOAPFaultException</code> object. It is
+ * in a <code>SOAPFault</code> object. It is
* the base class for all of the classes that represent the SOAP objects as
* defined in the SOAP specification.
*/
1.7 +10 -6 xml-axis/java/src/javax/xml/soap/SOAPElementFactory.java
Index: SOAPElementFactory.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/soap/SOAPElementFactory.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- SOAPElementFactory.java 16 Jun 2002 19:36:54 -0000 1.6
+++ SOAPElementFactory.java 16 Jun 2002 22:19:49 -0000 1.7
@@ -65,7 +65,8 @@
* properties of an element that lives inside a SOAP header
* document. These elements are copied into the XML document tree
* when they are inserted.</P>
- * @deprecated Use javax.xml.soap.SOAPFactory for creating SOAPElements.
+ * @deprecated - Use javax.xml.soap.SOAPFactory for creating SOAPElements.
+ * @see SOAPFactory SOAPFactory
*/
public class SOAPElementFactory {
@@ -87,7 +88,8 @@
* created
* @throws SOAPException if there is an error in
* creating the <CODE>SOAPElement</CODE> object
- * @deprecated Use javax.xml.soap.SOAPFactory for creating SOAPElements.
+ * @deprecated Use javax.xml.soap.SOAPFactory.createElement(javax.xml.soap.Name) instead
+ * @see SOAPFactory#createElement(javax.xml.soap.Name) SOAPFactory.createElement(javax.xml.soap.Name)
*/
public SOAPElement create(Name name) throws SOAPException {
return sf.createElement(name);
@@ -102,7 +104,8 @@
* created
* @throws SOAPException if there is an error in
* creating the <CODE>SOAPElement</CODE> object
- * @deprecated Use javax.xml.soap.SOAPFactory for creating SOAPElements.
+ * @deprecated Use javax.xml.soap.SOAPFactory.createElement(String localName) instead
+ * @see SOAPFactory#createElement(java.lang.String) SOAPFactory.createElement(java.lang.String)
*/
public SOAPElement create(String localName) throws SOAPException {
return sf.createElement(localName);
@@ -122,7 +125,8 @@
* created
* @throws SOAPException if there is an error in
* creating the <CODE>SOAPElement</CODE> object
- * @deprecated Use javax.xml.soap.SOAPFactory for creating SOAPElements.
+ * @deprecated Use javax.xml.soap.SOAPFactory.createElement(String localName, String prefix, String uri) instead
+ * @see SOAPFactory#createElement(java.lang.String, java.lang.String, java.lang.String) SOAPFactory.createElement(java.lang.String, java.lang.String, java.lang.String)
*/
public SOAPElement create(String localName, String prefix, String uri)
throws SOAPException {
@@ -130,8 +134,8 @@
}
/**
- * Creates a new instance of <CODE>
- * SOAPElementFactory</CODE>.
+ * Creates a new instance of <CODE>SOAPElementFactory</CODE>.
+ *
* @return a new instance of a <CODE>
* SOAPElementFactory</CODE>
* @throws SOAPException if there was an error creating
1.3 +88 -62 xml-axis/java/src/javax/xml/soap/SOAPFactory.java
Index: SOAPFactory.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/soap/SOAPFactory.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- SOAPFactory.java 16 Jun 2002 19:36:54 -0000 1.2
+++ SOAPFactory.java 16 Jun 2002 22:19:49 -0000 1.3
@@ -55,94 +55,120 @@
package javax.xml.soap;
/**
- * Class SOAPFactory
+ * <code>SOAPFactory</code> is a factory for creating various objects
+ * that exist in the SOAP XML tree.
+ *
+ * <code>SOAPFactory</code> can be
+ * used to create XML fragments that will eventually end up in the
+ * SOAP part. These fragments can be inserted as children of the
+ * <code>SOAPHeaderElement</code> or <code>SOAPBodyElement</code> or
+ * <code>SOAPEnvelope</code>.
+ *
+ * <code>SOAPFactory</code> also has methods to create
+ * <code>javax.xml.soap.Detail</code> objects as well as
+ * <code>java.xml.soap.Name</code> objects.
*
- * @author
- * @version %I%, %G%
*/
public abstract class SOAPFactory {
- /**
- * Constructor SOAPFactory
- */
+ /** */
public SOAPFactory() {}
/**
- * Method createElement
+ * Create a <code>SOAPElement</code> object initialized with the
+ * given <code>Name</code> object.
*
- * @param name
- *
- * @return
- *
- * @throws SOAPException
+ * @param name a <code>Name</code> object with the XML name for
+ * the new element
+ * @return the new <code>SOAPElement</code> object that was
+ * created
+ * @throws SOAPException if there is an error in creating the
+ * <code>SOAPElement</code> object
*/
public abstract SOAPElement createElement(Name name) throws SOAPException;
/**
- * Method createElement
- *
- * @param s
- *
- * @return
- *
- * @throws SOAPException
- */
- public abstract SOAPElement createElement(String s) throws SOAPException;
-
- /**
- * Method createElement
- *
- * @param s
- * @param s1
- * @param s2
+ * Create a <code>SOAPElement</code> object initialized with the
+ * given local name.
*
- * @return
- *
- * @throws SOAPException
+ * @param localName a <code>String</code> giving the local name for
+ * the new element
+ * @return the new <code>SOAPElement</code> object that was
+ * created
+ * @throws SOAPException if there is an error in creating the
+ * <code>SOAPElement</code> object
+ */
+ public abstract SOAPElement createElement(String localName) throws SOAPException;
+
+ /**
+ * Create a new <code>SOAPElement</code> object with the given
+ * local name, prefix and uri.
+ *
+ * @param localName a <code>String</code> giving the local name
+ * for the new element
+ * @param prefix the prefix for this <code>SOAPElement</code>
+ * @param uri a <code>String</code> giving the URI of the
+ * namespace to which the new element belongs
+ * @return the new <code>SOAPElement</code> object that was
+ * created
+ * @throws SOAPException if there is an error in creating the
+ * <code>SOAPElement</code> object
*/
- public abstract SOAPElement createElement(String s, String s1, String s2)
+ public abstract SOAPElement createElement(String localName, String prefix, String uri)
throws SOAPException;
/**
- * Method createDetail
- *
- * @return
+ * Creates a new <code>Detail</code> object which serves as a container
+ * for <code>DetailEntry</code> objects.
+ * <p>
+ * This factory method creates <code>Detail</code> objects for use in
+ * situations where it is not practical to use the <code>SOAPFault</code>
+ * abstraction.
*
- * @throws SOAPException
+ * @return a <code>Detail</code> object
+ * @throws SOAPException if there is a SOAP error
*/
public abstract Detail createDetail() throws SOAPException;
/**
- * Method createName
- *
- * @param s
- * @param s1
- * @param s2
- *
- * @return
- *
- * @throws SOAPException
+ * Creates a new <code>Name</code> object initialized with the
+ * given local name, namespace prefix, and namespace URI.
+ * <p>
+ * This factory method creates <code>Name</code> objects for use in
+ * situations where it is not practical to use the <code>SOAPEnvelope</code>
+ * abstraction.
+ *
+ * @param localName a <code>String</code> giving the local name
+ * @param prefix a <code>String</code> giving the prefix of the namespace
+ * @param uri a <code>String</code> giving the URI of the namespace
+ * @return a <code>Name</code> object initialized with the given
+ * local name, namespace prefix, and namespace URI
+ * @throws SOAPException if there is a SOAP error
*/
- public abstract Name createName(String s, String s1, String s2)
+ public abstract Name createName(String localName, String prefix, String uri)
throws SOAPException;
/**
- * Method createName
- *
- * @param s
- *
- * @return
- *
- * @throws SOAPException
- */
- public abstract Name createName(String s) throws SOAPException;
-
- /**
- * Method newInstance
- *
- * @return
- *
- * @throws SOAPException
+ * Creates a new <code>Name</code> object initialized with the
+ * given local name.
+ * <p>
+ * This factory method creates <code>Name</code> objects for use in
+ * situations where it is not practical to use the <code>SOAPEnvelope</code>
+ * abstraction.
+ *
+ * @param localName a <code>String</code> giving the local name
+ * @return a <code>Name</code> object initialized with the given
+ * local name
+ * @throws SOAPException if there is a SOAP error
+ */
+ public abstract Name createName(String localName) throws SOAPException;
+
+ /**
+ * Creates a new instance of <code>SOAPFactory</code>.
+ *
+ * @return a new instance of a <code>SOAPFactory</code>
+ * @throws SOAPException if there was an error creating the
+ * default <code>SOAPFactory</code>
*/
public static SOAPFactory newInstance() throws SOAPException {
1.3 +16 -13 xml-axis/java/src/javax/xml/soap/SOAPFault.java
Index: SOAPFault.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/soap/SOAPFault.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- SOAPFault.java 13 May 2002 13:11:33 -0000 1.2
+++ SOAPFault.java 16 Jun 2002 22:19:49 -0000 1.3
@@ -63,9 +63,9 @@
* in processing, such as the inability to communicate with an
* upstream server.
* <P>
- * The <CODE>SOAPFaultException</CODE> interface provides methods for
+ * The <CODE>SOAPFault</CODE> interface provides methods for
* retrieving the information contained in a <CODE>
- * SOAPFaultException</CODE> object and for setting the fault code, the
+ * SOAPFault</CODE> object and for setting the fault code, the
* fault actor, and a string describing the fault. A fault code is
* one of the codes defined in the SOAP 1.1 specification that
* describe the fault. An actor is an intermediate recipient to
@@ -77,7 +77,7 @@
public interface SOAPFault extends SOAPBodyElement {
/**
- * Sets this <CODE>SOAPFaultException</CODE> object with the given
+ * Sets this <CODE>SOAPFault</CODE> object with the given
* fault code.
*
* <P>Fault codes, which given information about the fault,
@@ -88,42 +88,45 @@
* @throws SOAPException if there was an error in
* adding the <CODE>faultCode</CODE> to the underlying XML
* tree.
+ * @see #getFaultCode() getFaultCode()
*/
public abstract void setFaultCode(String faultCode) throws SOAPException;
/**
- * Gets the fault code for this <CODE>SOAPFaultException</CODE>
+ * Gets the fault code for this <CODE>SOAPFault</CODE>
* object.
* @return a <CODE>String</CODE> with the fault code
+ * @see #setFaultCode(java.lang.String) setFaultCode(java.lang.String)
*/
public abstract String getFaultCode();
/**
- * Sets this <CODE>SOAPFaultException</CODE> object with the given
+ * Sets this <CODE>SOAPFault</CODE> object with the given
* fault actor.
*
* <P>The fault actor is the recipient in the message path who
* caused the fault to happen.</P>
* @param faultActor a <CODE>String</CODE>
* identifying the actor that caused this <CODE>
- * SOAPFaultException</CODE> object
+ * SOAPFault</CODE> object
* @throws SOAPException if there was an error in
* adding the <CODE>faultActor</CODE> to the underlying XML
* tree.
+ * @see #getFaultActor() getFaultActor()
*/
public abstract void setFaultActor(String faultActor) throws SOAPException;
/**
- * Gets the fault actor for this <CODE>SOAPFaultException</CODE>
+ * Gets the fault actor for this <CODE>SOAPFault</CODE>
* object.
* @return a <CODE>String</CODE> giving the actor in the message
- * path that caused this <CODE>SOAPFaultException</CODE> object
+ * path that caused this <CODE>SOAPFault</CODE> object
* @see #setFaultActor(java.lang.String) setFaultActor(java.lang.String)
*/
public abstract String getFaultActor();
/**
- * Sets the fault string for this <CODE>SOAPFaultException</CODE>
+ * Sets the fault string for this <CODE>SOAPFault</CODE>
* object to the given string.
*
* @param faultString a <CODE>String</CODE>
@@ -137,7 +140,7 @@
throws SOAPException;
/**
- * Gets the fault string for this <CODE>SOAPFaultException</CODE>
+ * Gets the fault string for this <CODE>SOAPFault</CODE>
* object.
* @return a <CODE>String</CODE> giving an explanation of the
* fault
@@ -145,7 +148,7 @@
public abstract String getFaultString();
/**
- * Returns the detail element for this <CODE>SOAPFaultException</CODE>
+ * Returns the detail element for this <CODE>SOAPFault</CODE>
* object.
*
* <P>A <CODE>Detail</CODE> object carries
@@ -158,7 +161,7 @@
/**
* Creates a <CODE>Detail</CODE> object and sets it as the
- * <CODE>Detail</CODE> object for this <CODE>SOAPFaultException</CODE>
+ * <CODE>Detail</CODE> object for this <CODE>SOAPFault</CODE>
* object.
*
* <P>It is illegal to add a detail when the fault already
@@ -166,7 +169,7 @@
* only after the existing detail has been removed.</P>
* @return the new <CODE>Detail</CODE> object
* @throws SOAPException if this
- * <CODE>SOAPFaultException</CODE> object already contains a valid
+ * <CODE>SOAPFault</CODE> object already contains a valid
* <CODE>Detail</CODE> object
*/
public abstract Detail addDetail() throws SOAPException;
1.4 +8 -1 xml-axis/java/src/javax/xml/soap/SOAPFaultElement.java
Index: SOAPFaultElement.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/soap/SOAPFaultElement.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- SOAPFaultElement.java 16 Jun 2002 19:36:54 -0000 1.3
+++ SOAPFaultElement.java 16 Jun 2002 22:19:49 -0000 1.4
@@ -54,5 +54,12 @@
*/
package javax.xml.soap;
-/** */
+/**
+ * A representation of the contents in
+ * a <code>SOAPFault</code> object. The <code>Detail</code> interface
+ * is a <code>SOAPFaultElement</code> object that has been defined.
+ * <p>
+ * Content is added to a <code>SOAPFaultElement</code> using the
+ * <code>SOAPElement</code> method <code>addTextNode</code>.
+ */
public interface SOAPFaultElement extends SOAPElement {}
1.4 +2 -2 xml-axis/java/src/javax/xml/soap/SOAPHeaderElement.java
Index: SOAPHeaderElement.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/soap/SOAPHeaderElement.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- SOAPHeaderElement.java 30 May 2002 03:06:05 -0000 1.3
+++ SOAPHeaderElement.java 16 Jun 2002 22:19:49 -0000 1.4
@@ -69,7 +69,7 @@
* Sets the actor associated with this <CODE>
* SOAPHeaderElement</CODE> object to the specified actor. The
* default value of an actor is: <CODE>
- * SOAPConstants.NS_URI_SOAP_ACTOR_NEXT</CODE>
+ * SOAPConstants.URI_SOAP_ACTOR_NEXT</CODE>
* @param actorURI a <CODE>String</CODE> giving
* the URI of the actor to set
* @see #getActor() getActor()
@@ -83,7 +83,7 @@
* SOAPHeaderElement</CODE> object.
* @return a <CODE>String</CODE> giving the URI of the
* actor
- * @see #setActor(String) setActor()
+ * @see #setActor(java.lang.String) setActor(java.lang.String)
*/
public abstract String getActor();
1.3 +1 -0 xml-axis/java/src/javax/xml/soap/SOAPPart.java
Index: SOAPPart.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/soap/SOAPPart.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- SOAPPart.java 29 Jan 2002 01:52:45 -0000 1.2
+++ SOAPPart.java 16 Jun 2002 22:19:49 -0000 1.3
@@ -221,6 +221,7 @@
* @ throws java.lang.IllegalArgumentException if
* there was a problem with the specified mime header name
* or value
+ * @throws java.lang.IllegalArgumentException if there was a problem with the specified mime header name or value
* @see #getMimeHeader(java.lang.String) getMimeHeader(java.lang.String)
*/
public abstract void setMimeHeader(String name, String value);
1.102 +1 -1 xml-axis/java/src/org/apache/axis/message/MessageElement.java
Index: MessageElement.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/org/apache/axis/message/MessageElement.java,v
retrieving revision 1.101
retrieving revision 1.102
diff -u -r1.101 -r1.102
--- MessageElement.java 11 Jun 2002 14:53:58 -0000 1.101
+++ MessageElement.java 16 Jun 2002 22:19:50 -0000 1.102
@@ -268,7 +268,7 @@
* Obtain an Attributes collection consisting of all attributes
* for this MessageElement, including namespace declarations.
*
- * @return
+ * @return Attributes collection
*/
public Attributes getCompleteAttributes() {
if (namespaces == null)
1.5 +1 -1 xml-axis/java/src/javax/xml/rpc/ParameterMode.java
Index: ParameterMode.java
===================================================================
RCS file: /home/cvs/xml-axis/java/src/javax/xml/rpc/ParameterMode.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- ParameterMode.java 16 Jun 2002 19:36:55 -0000 1.4
+++ ParameterMode.java 16 Jun 2002 22:19:50 -0000 1.5
@@ -87,7 +87,7 @@
/**
* Method toString
*
- * @return
+ * @return String
*/
public String toString() {
return mode;