SOAPMessage
+ * The container for the SOAP-specific portion of a {@code SOAPMessage}
* object. All messages are required to have a SOAP part, so when a
- * SOAPMessage object is created, it will automatically
- * have a SOAPPart object.
- *
- * A SOAPPart object is a MIME part and has the MIME headers
+ * {@code SOAPMessage} object is created, it will automatically
+ * have a {@code SOAPPart} object.
+ *
+ * A {@code SOAPPart} object is a MIME part and has the MIME headers
* Content-Id, Content-Location, and Content-Type. Because the value of
- * Content-Type must be "text/xml", a SOAPPart object automatically
+ * Content-Type must be "text/xml", a {@code SOAPPart} object automatically
* has a MIME header of Content-Type with its value set to "text/xml".
* The value must be "text/xml" because content in the SOAP part of a
* message must be in XML format. Content that is not of type "text/xml"
- * must be in an AttachmentPart object rather than in the
- * SOAPPart object.
+ * must be in an {@code AttachmentPart} object rather than in the
+ * {@code SOAPPart} object.
*
* When a message is sent, its SOAP part must have the MIME header Content-Type * set to "text/xml". Or, from the other perspective, the SOAP part of any * message that is received must have the MIME header Content-Type with a * value of "text/xml". *
- * A client can access the SOAPPart object of a
- * SOAPMessage object by
- * calling the method SOAPMessage.getSOAPPart. The
- * following line of code, in which message is a
- * SOAPMessage object, retrieves the SOAP part of a message.
+ * A client can access the {@code SOAPPart} object of a
+ * {@code SOAPMessage} object by
+ * calling the method {@code SOAPMessage.getSOAPPart}. The
+ * following line of code, in which {@code message} is a
+ * {@code SOAPMessage} object, retrieves the SOAP part of a message.
*
* SOAPPart soapPart = message.getSOAPPart(); **
- * A SOAPPart object contains a SOAPEnvelope object,
- * which in turn contains a SOAPBody object and a
- * SOAPHeader object.
- * The SOAPPart method getEnvelope can be used
- * to retrieve the SOAPEnvelope object.
- *
+ * A {@code SOAPPart} object contains a {@code SOAPEnvelope} object,
+ * which in turn contains a {@code SOAPBody} object and a
+ * {@code SOAPHeader} object.
+ * The {@code SOAPPart} method {@code getEnvelope} can be used
+ * to retrieve the {@code SOAPEnvelope} object.
*
* @since 1.6
*/
public abstract class SOAPPart implements org.w3c.dom.Document, Node {
/**
- * Gets the SOAPEnvelope object associated with this
- * SOAPPart object. Once the SOAP envelope is obtained, it
+ * Gets the {@code SOAPEnvelope} object associated with this
+ * {@code SOAPPart} object. Once the SOAP envelope is obtained, it
* can be used to get its contents.
*
- * @return the SOAPEnvelope object for this
- * SOAPPart object
+ * @return the {@code SOAPEnvelope} object for this
+ * {@code SOAPPart} object
* @exception SOAPException if there is a SOAP error
*/
public abstract SOAPEnvelope getEnvelope() throws SOAPException;
@@ -83,7 +82,7 @@
/**
* Retrieves the value of the MIME header whose name is "Content-Id".
*
- * @return a String giving the value of the MIME header
+ * @return a {@code String} giving the value of the MIME header
* named "Content-Id"
* @see #setContentId
*/
@@ -97,7 +96,7 @@
/**
* Retrieves the value of the MIME header whose name is "Content-Location".
*
- * @return a String giving the value of the MIME header whose
+ * @return a {@code String} giving the value of the MIME header whose
* name is "Content-Location"
* @see #setContentLocation
*/
@@ -110,9 +109,9 @@
/**
* Sets the value of the MIME header named "Content-Id"
- * to the given String.
+ * to the given {@code String}.
*
- * @param contentId a String giving the value of the MIME
+ * @param contentId a {@code String} giving the value of the MIME
* header "Content-Id"
*
* @exception IllegalArgumentException if there is a problem in
@@ -125,9 +124,9 @@
}
/**
* Sets the value of the MIME header "Content-Location"
- * to the given String.
+ * to the given {@code String}.
*
- * @param contentLocation a String giving the value
+ * @param contentLocation a {@code String} giving the value
* of the MIME
* header "Content-Location"
* @exception IllegalArgumentException if there is a problem in
@@ -141,24 +140,24 @@
/**
* Removes all MIME headers that match the given name.
*
- * @param header a String giving the name of the MIME header(s) to
+ * @param header a {@code String} giving the name of the MIME header(s) to
* be removed
*/
public abstract void removeMimeHeader(String header);
/**
- * Removes all the MimeHeader objects for this
- * SOAPEnvelope object.
+ * Removes all the {@code MimeHeader} objects for this
+ * {@code SOAPEnvelope} object.
*/
public abstract void removeAllMimeHeaders();
/**
- * Gets all the values of the MimeHeader object
- * in this SOAPPart object that
- * is identified by the given String.
+ * Gets all the values of the {@code MimeHeader} object
+ * in this {@code SOAPPart} object that
+ * is identified by the given {@code String}.
*
* @param name the name of the header; example: "Content-Type"
- * @return a String array giving all the values for the
+ * @return a {@code String} array giving all the values for the
* specified header
* @see #setMimeHeader
*/
@@ -176,13 +175,13 @@
*
* Note that RFC822 headers can contain only US-ASCII characters.
*
- * @param name a String giving the header name
+ * @param name a {@code String} giving the header name
* for which to search
- * @param value a String giving the value to be set.
+ * @param value a {@code String} giving the value to be set.
* This value will be substituted for the current value(s)
* of the first header that is a match if there is one.
* If there is no match, this value will be the value for
- * a new MimeHeader object.
+ * a new {@code MimeHeader} object.
*
* @exception IllegalArgumentException if there was a problem with
* the specified mime header name or value
@@ -191,16 +190,16 @@
public abstract void setMimeHeader(String name, String value);
/**
- * Creates a MimeHeader object with the specified
- * name and value and adds it to this SOAPPart object.
- * If a MimeHeader with the specified name already
+ * Creates a {@code MimeHeader} object with the specified
+ * name and value and adds it to this {@code SOAPPart} object.
+ * If a {@code MimeHeader} with the specified name already
* exists, this method adds the specified value to the already
* existing value(s).
*
* Note that RFC822 headers can contain only US-ASCII characters.
*
- * @param name a String giving the header name
- * @param value a String giving the value to be set
+ * @param name a {@code String} giving the header name
+ * @param value a {@code String} giving the value to be set
* or added
* @exception IllegalArgumentException if there was a problem with
* the specified mime header name or value
@@ -208,44 +207,44 @@
public abstract void addMimeHeader(String name, String value);
/**
- * Retrieves all the headers for this SOAPPart object
- * as an iterator over the MimeHeader objects.
+ * Retrieves all the headers for this {@code SOAPPart} object
+ * as an iterator over the {@code MimeHeader} objects.
*
- * @return an Iterator object with all of the Mime
- * headers for this SOAPPart object
+ * @return an {@code Iterator} object with all of the Mime
+ * headers for this {@code SOAPPart} object
*/
public abstract Iterator getAllMimeHeaders();
/**
- * Retrieves all MimeHeader objects that match a name in
+ * Retrieves all {@code MimeHeader} objects that match a name in
* the given array.
*
- * @param names a String array with the name(s) of the
+ * @param names a {@code String} array with the name(s) of the
* MIME headers to be returned
* @return all of the MIME headers that match one of the names in the
- * given array, returned as an Iterator object
+ * given array, returned as an {@code Iterator} object
*/
public abstract Iterator getMatchingMimeHeaders(String[] names);
/**
- * Retrieves all MimeHeader objects whose name does
+ * Retrieves all {@code MimeHeader} objects whose name does
* not match a name in the given array.
*
- * @param names a String array with the name(s) of the
+ * @param names a {@code String} array with the name(s) of the
* MIME headers not to be returned
- * @return all of the MIME headers in this SOAPPart object
+ * @return all of the MIME headers in this {@code SOAPPart} object
* except those that match one of the names in the
* given array. The nonmatching MIME headers are returned as an
- * Iterator object.
+ * {@code Iterator} object.
*/
public abstract Iterator getNonMatchingMimeHeaders(String[] names);
/**
- * Sets the content of the SOAPEnvelope object with the data
- * from the given Source object. This Source
+ * Sets the content of the {@code SOAPEnvelope} object with the data
+ * from the given {@code Source} object. This {@code Source}
* must contain a valid SOAP document.
*
- * @param source the javax.xml.transform.Source object with the
+ * @param source the {@code javax.xml.transform.Source} object with the
* data to be set
*
* @exception SOAPException if there is a problem in setting the source
@@ -254,13 +253,13 @@
public abstract void setContent(Source source) throws SOAPException;
/**
- * Returns the content of the SOAPEnvelope as a JAXP Source
+ * Returns the content of the SOAPEnvelope as a JAXP {@code Source}
* object.
*
- * @return the content as a javax.xml.transform.Source object
+ * @return the content as a {@code javax.xml.transform.Source} object
*
* @exception SOAPException if the implementation cannot convert
- * the specified Source object
+ * the specified {@code Source} object
* @see #setContent
*/
public abstract Source getContent() throws SOAPException;