- * A SOAPBody object contains SOAPBodyElement
+ * A {@code SOAPBody} object contains {@code SOAPBodyElement}
* objects, which have the content for the SOAP body.
- * A SOAPFault object, which carries status and/or
- * error information, is an example of a SOAPBodyElement object.
+ * A {@code SOAPFault} object, which carries status and/or
+ * error information, is an example of a {@code SOAPBodyElement} object.
*
* @see SOAPFault
* @since 1.6
@@ -47,47 +47,47 @@
public interface SOAPBody extends SOAPElement {
/**
- * Creates a new SOAPFault object and adds it to
- * this SOAPBody object. The new SOAPFault will
+ * Creates a new {@code SOAPFault} object and adds it to
+ * this {@code SOAPBody} object. The new {@code SOAPFault} will
* have default values set for the mandatory child elements. The type of
- * the SOAPFault will be a SOAP 1.1 or a SOAP 1.2 SOAPFault
- * depending on the protocol specified while creating the
- * MessageFactory instance.
+ * the {@code SOAPFault} will be a SOAP 1.1 or a SOAP 1.2 {@code SOAPFault}
+ * depending on the {@code protocol} specified while creating the
+ * {@code MessageFactory} instance.
*
- * A SOAPBody may contain at most one SOAPFault
+ * A {@code SOAPBody} may contain at most one {@code SOAPFault}
* child element.
*
- * @return the new SOAPFault object
+ * @return the new {@code SOAPFault} object
* @exception SOAPException if there is a SOAP error
*/
public SOAPFault addFault() throws SOAPException;
/**
- * Creates a new SOAPFault object and adds it to
- * this SOAPBody object. The type of the
- * SOAPFault will be a SOAP 1.1 or a SOAP 1.2
- * SOAPFault depending on the protocol
- * specified while creating the MessageFactory instance.
+ * Creates a new {@code SOAPFault} object and adds it to
+ * this {@code SOAPBody} object. The type of the
+ * {@code SOAPFault} will be a SOAP 1.1 or a SOAP 1.2
+ * {@code SOAPFault} depending on the {@code protocol}
+ * specified while creating the {@code MessageFactory} instance.
*
- * For SOAP 1.2 the faultCode parameter is the value of the
- * Fault/Code/Value element and the faultString parameter
+ * For SOAP 1.2 the {@code faultCode} parameter is the value of the
+ * Fault/Code/Value element and the {@code faultString} parameter
* is the value of the Fault/Reason/Text element. For SOAP 1.1
- * the faultCode parameter is the value of the faultcode
- * element and the faultString parameter is the value of the faultstring
+ * the {@code faultCode} parameter is the value of the {@code faultcode}
+ * element and the {@code faultString} parameter is the value of the {@code faultstring}
* element.
*
- * A SOAPBody may contain at most one SOAPFault
+ * A {@code SOAPBody} may contain at most one {@code SOAPFault}
* child element.
*
- * @param faultCode a Name object giving the fault
+ * @param faultCode a {@code Name} object giving the fault
* code to be set; must be one of the fault codes defined in the Version
* of SOAP specification in use
- * @param faultString a String giving an explanation of
+ * @param faultString a {@code String} giving an explanation of
* the fault
* @param locale a {@link java.util.Locale} object indicating
- * the native language of the faultString
- * @return the new SOAPFault object
+ * the native language of the {@code faultString}
+ * @return the new {@code SOAPFault} object
* @exception SOAPException if there is a SOAP error
* @see SOAPFault#setFaultCode
* @see SOAPFault#setFaultString
@@ -96,32 +96,32 @@
public SOAPFault addFault(Name faultCode, String faultString, Locale locale) throws SOAPException;
/**
- * Creates a new SOAPFault object and adds it to this
- * SOAPBody object. The type of the SOAPFault
- * will be a SOAP 1.1 or a SOAP 1.2 SOAPFault depending on
- * the protocol specified while creating the MessageFactory
+ * Creates a new {@code SOAPFault} object and adds it to this
+ * {@code SOAPBody} object. The type of the {@code SOAPFault}
+ * will be a SOAP 1.1 or a SOAP 1.2 {@code SOAPFault} depending on
+ * the {@code protocol} specified while creating the {@code MessageFactory}
* instance.
*
- * For SOAP 1.2 the faultCode parameter is the value of the
- * Fault/Code/Value element and the faultString parameter
+ * For SOAP 1.2 the {@code faultCode} parameter is the value of the
+ * Fault/Code/Value element and the {@code faultString} parameter
* is the value of the Fault/Reason/Text element. For SOAP 1.1
- * the faultCode parameter is the value of the faultcode
- * element and the faultString parameter is the value of the faultstring
+ * the {@code faultCode} parameter is the value of the {@code faultcode}
+ * element and the {@code faultString} parameter is the value of the {@code faultstring}
* element.
*
- * A SOAPBody may contain at most one SOAPFault
+ * A {@code SOAPBody} may contain at most one {@code SOAPFault}
* child element.
*
* @param faultCode
- * a QName object giving the fault code to be
+ * a {@code QName} object giving the fault code to be
* set; must be one of the fault codes defined in the version
* of SOAP specification in use.
* @param faultString
- * a String giving an explanation of the fault
+ * a {@code String} giving an explanation of the fault
* @param locale
* a {@link java.util.Locale Locale} object indicating the
- * native language of the faultString
- * @return the new SOAPFault object
+ * native language of the {@code faultString}
+ * @return the new {@code SOAPFault} object
* @exception SOAPException
* if there is a SOAP error
* @see SOAPFault#setFaultCode
@@ -134,33 +134,33 @@
throws SOAPException;
/**
- * Creates a new SOAPFault object and adds it to this
- * SOAPBody object. The type of the SOAPFault
- * will be a SOAP 1.1 or a SOAP 1.2 SOAPFault depending on
- * the protocol specified while creating the MessageFactory
+ * Creates a new {@code SOAPFault} object and adds it to this
+ * {@code SOAPBody} object. The type of the {@code SOAPFault}
+ * will be a SOAP 1.1 or a SOAP 1.2 {@code SOAPFault} depending on
+ * the {@code protocol} specified while creating the {@code MessageFactory}
* instance.
*
- * For SOAP 1.2 the faultCode parameter is the value of the
- * Fault/Code/Value element and the faultString parameter
+ * For SOAP 1.2 the {@code faultCode} parameter is the value of the
+ * Fault/Code/Value element and the {@code faultString} parameter
* is the value of the Fault/Reason/Text element. For SOAP 1.1
- * the faultCode parameter is the value of the faultcode
- * element and the faultString parameter is the value of the faultstring
+ * the {@code faultCode} parameter is the value of the faultcode
+ * element and the {@code faultString} parameter is the value of the faultstring
* element.
*
- * In case of a SOAP 1.2 fault, the default value for the mandatory xml:lang
+ * In case of a SOAP 1.2 fault, the default value for the mandatory {@code xml:lang}
* attribute on the Fault/Reason/Text element will be set to
- * java.util.Locale.getDefault()
+ * {@code java.util.Locale.getDefault()}
*
- * A SOAPBody may contain at most one SOAPFault
+ * A {@code SOAPBody} may contain at most one {@code SOAPFault}
* child element.
*
* @param faultCode
- * a Name object giving the fault code to be set;
+ * a {@code Name} object giving the fault code to be set;
* must be one of the fault codes defined in the version of SOAP
* specification in use
* @param faultString
- * a String giving an explanation of the fault
- * @return the new SOAPFault object
+ * a {@code String} giving an explanation of the fault
+ * @return the new {@code SOAPFault} object
* @exception SOAPException
* if there is a SOAP error
* @see SOAPFault#setFaultCode
@@ -171,33 +171,33 @@
throws SOAPException;
/**
- * Creates a new SOAPFault object and adds it to this SOAPBody
- * object. The type of the SOAPFault
- * will be a SOAP 1.1 or a SOAP 1.2 SOAPFault depending on
- * the protocol specified while creating the MessageFactory
+ * Creates a new {@code SOAPFault} object and adds it to this {@code SOAPBody}
+ * object. The type of the {@code SOAPFault}
+ * will be a SOAP 1.1 or a SOAP 1.2 {@code SOAPFault} depending on
+ * the {@code protocol} specified while creating the {@code MessageFactory}
* instance.
*
- * For SOAP 1.2 the faultCode parameter is the value of the
- * Fault/Code/Value element and the faultString parameter
+ * For SOAP 1.2 the {@code faultCode} parameter is the value of the
+ * Fault/Code/Value element and the {@code faultString} parameter
* is the value of the Fault/Reason/Text element. For SOAP 1.1
- * the faultCode parameter is the value of the faultcode
- * element and the faultString parameter is the value of the faultstring
+ * the {@code faultCode} parameter is the value of the faultcode
+ * element and the {@code faultString} parameter is the value of the faultstring
* element.
*
- * In case of a SOAP 1.2 fault, the default value for the mandatory xml:lang
+ * In case of a SOAP 1.2 fault, the default value for the mandatory {@code xml:lang}
* attribute on the Fault/Reason/Text element will be set to
- * java.util.Locale.getDefault()
+ * {@code java.util.Locale.getDefault()}
*
- * A SOAPBody may contain at most one SOAPFault
+ * A {@code SOAPBody} may contain at most one {@code SOAPFault}
* child element
*
* @param faultCode
- * a QName object giving the fault code to be
+ * a {@code QName} object giving the fault code to be
* set; must be one of the fault codes defined in the version
* of SOAP specification in use
* @param faultString
- * a String giving an explanation of the fault
- * @return the new SOAPFault object
+ * a {@code String} giving an explanation of the fault
+ * @return the new {@code SOAPFault} object
* @exception SOAPException
* if there is a SOAP error
* @see SOAPFault#setFaultCode
@@ -209,32 +209,32 @@
throws SOAPException;
/**
- * Indicates whether a SOAPFault object exists in this
- * SOAPBody object.
+ * Indicates whether a {@code SOAPFault} object exists in this
+ * {@code SOAPBody} object.
*
- * @return true if a SOAPFault object exists
- * in this SOAPBody object; false
+ * @return {@code true} if a {@code SOAPFault} object exists
+ * in this {@code SOAPBody} object; {@code false}
* otherwise
*/
public boolean hasFault();
/**
- * Returns the SOAPFault object in this SOAPBody
+ * Returns the {@code SOAPFault} object in this {@code SOAPBody}
* object.
*
- * @return the SOAPFault object in this SOAPBody
+ * @return the {@code SOAPFault} object in this {@code SOAPBody}
* object if present, null otherwise.
*/
public SOAPFault getFault();
/**
- * Creates a new SOAPBodyElement object with the specified
- * name and adds it to this SOAPBody object.
+ * Creates a new {@code SOAPBodyElement} object with the specified
+ * name and adds it to this {@code SOAPBody} object.
*
* @param name
- * a Name object with the name for the new SOAPBodyElement
+ * a {@code Name} object with the name for the new {@code SOAPBodyElement}
* object
- * @return the new SOAPBodyElement object
+ * @return the new {@code SOAPBodyElement} object
* @exception SOAPException
* if a SOAP error occurs
* @see SOAPBody#addBodyElement(javax.xml.namespace.QName)
@@ -243,13 +243,13 @@
/**
- * Creates a new SOAPBodyElement object with the specified
- * QName and adds it to this SOAPBody object.
+ * Creates a new {@code SOAPBodyElement} object with the specified
+ * QName and adds it to this {@code SOAPBody} object.
*
* @param qname
- * a QName object with the qname for the new
- * SOAPBodyElement object
- * @return the new SOAPBodyElement object
+ * a {@code QName} object with the qname for the new
+ * {@code SOAPBodyElement} object
+ * @return the new {@code SOAPBodyElement} object
* @exception SOAPException
* if a SOAP error occurs
* @see SOAPBody#addBodyElement(Name)
@@ -259,20 +259,20 @@
/**
* Adds the root node of the DOM {@link org.w3c.dom.Document}
- * to this SOAPBody object.
+ * to this {@code SOAPBody} object.
*
- * Calling this method invalidates the document parameter.
- * The client application should discard all references to this Document
- * and its contents upon calling addDocument. The behavior
+ * Calling this method invalidates the {@code document} parameter.
+ * The client application should discard all references to this {@code Document}
+ * and its contents upon calling {@code addDocument}. The behavior
* of an application that continues to use such references is undefined.
*
* @param document
- * the Document object whose root node will be
- * added to this SOAPBody.
- * @return the SOAPBodyElement that represents the root node
+ * the {@code Document} object whose root node will be
+ * added to this {@code SOAPBody}.
+ * @return the {@code SOAPBodyElement} that represents the root node
* that was added.
* @exception SOAPException
- * if the Document cannot be added
+ * if the {@code Document} cannot be added
* @since 1.6, SAAJ 1.2
*/
public SOAPBodyElement addDocument(org.w3c.dom.Document document)
@@ -280,16 +280,16 @@
/**
* Creates a new DOM {@link org.w3c.dom.Document} and sets
- * the first child of this SOAPBody as it's document
- * element. The child SOAPElement is removed as part of the
+ * the first child of this {@code SOAPBody} as it's document
+ * element. The child {@code SOAPElement} is removed as part of the
* process.
*
* @return the {@link org.w3c.dom.Document} representation
- * of the SOAPBody content.
+ * of the {@code SOAPBody} content.
*
* @exception SOAPException
- * if there is not exactly one child SOAPElement of the
- * SOAPBody.
+ * if there is not exactly one child {@code SOAPElement} of the
+ * {@code SOAPBody}.
*
* @since 1.6, SAAJ 1.3
*/