You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@poi.apache.org by ki...@apache.org on 2021/12/31 00:01:17 UTC
svn commit: r1896561 [5/8] - in /xmlbeans: site/src/documentation/content/xdocs/ trunk/ trunk/gradle/ trunk/samples/ trunk/samples/AbstractTypes/ trunk/samples/Any/ trunk/samples/Any/src/org/apache/xmlbeans/samples/any/ trunk/samples/DateTime/ trunk/sa...
Modified: xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/MessageFactory.java
URL: http://svn.apache.org/viewvc/xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/MessageFactory.java?rev=1896561&r1=1896560&r2=1896561&view=diff
==============================================================================
--- xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/MessageFactory.java (original)
+++ xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/MessageFactory.java Fri Dec 31 00:01:16 2021
@@ -19,17 +19,17 @@ import java.io.IOException;
import java.io.InputStream;
/**
- * <P>A factory for creating <CODE>SOAPMessage</CODE> objects.</P>
+ * <P>A factory for creating {@code SOAPMessage} objects.</P>
*
* <P>A JAXM client performs the following steps to create a
* message.</P>
*
* <UL>
* <LI>
- * Creates a <CODE>MessageFactory</CODE> object from a <CODE>
- * ProviderConnection</CODE> object (<CODE>con</CODE> in the
- * following line of code). The <CODE>String</CODE> passed to
- * the <CODE>createMessageFactory</CODE> method is the name of
+ * Creates a {@code MessageFactory} object from a {@code
+ * ProviderConnection} object ({@code con} in the
+ * following line of code). The {@code String} passed to
+ * the {@code createMessageFactory} method is the name of
* of a messaging profile, which must be the URL for the
* schema.
* <PRE>
@@ -38,59 +38,59 @@ import java.io.InputStream;
* </LI>
*
* <LI>
- * Calls the method <CODE>createMessage</CODE> on the <CODE>
- * MessageFactory</CODE> object. All messages produced by this
- * <CODE>MessageFactory</CODE> object will have the header
+ * Calls the method {@code createMessage} on the {@code
+ * MessageFactory} object. All messages produced by this
+ * {@code MessageFactory} object will have the header
* information appropriate for the messaging profile that was
- * specified when the <CODE>MessageFactory</CODE> object was
+ * specified when the {@code MessageFactory} object was
* created.
* <PRE>
* SOAPMessage m = mf.createMessage();
* </PRE>
* </LI>
* </UL>
- * It is also possible to create a <CODE>MessageFactory</CODE>
- * object using the method <CODE>newInstance</CODE>, as shown in
+ * It is also possible to create a {@code MessageFactory}
+ * object using the method {@code newInstance}, as shown in
* the following line of code.
* <PRE>
* MessageFactory mf = MessageFactory.newInstance();
* </PRE>
* A standalone client (a client that is not running in a
- * container) can use the <CODE>newInstance</CODE> method to
- * create a <CODE>MessageFactory</CODE> object.
+ * container) can use the {@code newInstance} method to
+ * create a {@code MessageFactory} object.
*
- * <P>All <CODE>MessageFactory</CODE> objects, regardless of how
- * they are created, will produce <CODE>SOAPMessage</CODE> objects
+ * <P>All {@code MessageFactory} objects, regardless of how
+ * they are created, will produce {@code SOAPMessage} objects
* that have the following elements by default:</P>
*
* <UL>
- * <LI>A <CODE>SOAPPart</CODE> object</LI>
+ * <LI>A {@code SOAPPart} object</LI>
*
- * <LI>A <CODE>SOAPEnvelope</CODE> object</LI>
+ * <LI>A {@code SOAPEnvelope} object</LI>
*
- * <LI>A <CODE>SOAPBody</CODE> object</LI>
+ * <LI>A {@code SOAPBody} object</LI>
*
- * <LI>A <CODE>SOAPHeader</CODE> object</LI>
+ * <LI>A {@code SOAPHeader} object</LI>
* </UL>
- * If a <CODE>MessageFactory</CODE> object was created using a
- * <CODE>ProviderConnection</CODE> object, which means that it was
+ * If a {@code MessageFactory} object was created using a
+ * {@code ProviderConnection} object, which means that it was
* initialized with a specified profile, it will produce messages
* that also come prepopulated with additional entries in the
- * <CODE>SOAPHeader</CODE> object and the <CODE>SOAPBody</CODE>
- * object. The content of a new <CODE>SOAPMessage</CODE> object
- * depends on which of the two <CODE>MessageFactory</CODE> methods
+ * {@code SOAPHeader} object and the {@code SOAPBody}
+ * object. The content of a new {@code SOAPMessage} object
+ * depends on which of the two {@code MessageFactory} methods
* is used to create it.
*
* <UL>
- * <LI><CODE>createMessage()</CODE> -- message has no
+ * <LI>{@code createMessage()} -- message has no
* content<BR>
* This is the method clients would normally use to create a
* request message.</LI>
*
- * <LI><CODE>createMessage(MimeHeaders,
- * java.io.InputStream)</CODE> -- message has content from the
- * <CODE>InputStream</CODE> object and headers from the <CODE>
- * MimeHeaders</CODE> object<BR>
+ * <LI>{@code createMessage(MimeHeaders,
+ * java.io.InputStream)} -- message has content from the
+ * {@code InputStream} object and headers from the {@code
+ * MimeHeaders} object<BR>
* This method can be used internally by a service
* implementation to create a message that is a response to a
* request.</LI>
@@ -103,12 +103,12 @@ public abstract class MessageFactory {
public MessageFactory() {}
/**
- * Creates a new <CODE>MessageFactory</CODE> object that is
+ * Creates a new {@code MessageFactory} object that is
* an instance of the default implementation.
- * @return a new <CODE>MessageFactory</CODE> object
+ * @return a new {@code MessageFactory} object
* @throws SOAPException if there was an error in
- * creating the default implementation of the <CODE>
- * MessageFactory</CODE>
+ * creating the default implementation of the {@code
+ * MessageFactory}
*/
public static MessageFactory newInstance() throws SOAPException {
@@ -123,36 +123,36 @@ public abstract class MessageFactory {
}
/**
- * Creates a new <CODE>SOAPMessage</CODE> object with the
- * default <CODE>SOAPPart</CODE>, <CODE>SOAPEnvelope</CODE>,
- * <CODE>SOAPBody</CODE>, and <CODE>SOAPHeader</CODE> objects.
+ * Creates a new {@code SOAPMessage} object with the
+ * default {@code SOAPPart}, {@code SOAPEnvelope},
+ * {@code SOAPBody}, and {@code SOAPHeader} objects.
* Profile-specific message factories can choose to
- * prepopulate the <CODE>SOAPMessage</CODE> object with
+ * prepopulate the {@code SOAPMessage} object with
* profile-specific headers.
*
- * <P>Content can be added to this message's <CODE>
- * SOAPPart</CODE> object, and the message can be sent "as is"
+ * <P>Content can be added to this message's {@code
+ * SOAPPart} object, and the message can be sent "as is"
* when a message containing only a SOAP part is sufficient.
- * Otherwise, the <CODE>SOAPMessage</CODE> object needs to
- * create one or more <CODE>AttachmentPart</CODE> objects and
+ * Otherwise, the {@code SOAPMessage} object needs to
+ * create one or more {@code AttachmentPart} objects and
* add them to itself. Any content that is not in XML format
- * must be in an <CODE>AttachmentPart</CODE> object.</P>
- * @return a new <CODE>SOAPMessage</CODE> object
+ * must be in an {@code AttachmentPart} object.</P>
+ * @return a new {@code SOAPMessage} object
* @throws SOAPException if a SOAP error occurs
*/
public abstract SOAPMessage createMessage() throws SOAPException;
/**
- * Internalizes the contents of the given <CODE>
- * InputStream</CODE> object into a new <CODE>SOAPMessage</CODE>
- * object and returns the <CODE>SOAPMessage</CODE> object.
+ * Internalizes the contents of the given {@code
+ * InputStream} object into a new {@code SOAPMessage}
+ * object and returns the {@code SOAPMessage} object.
* @param mimeheaders the transport-specific headers
* passed to the message in a transport-independent fashion
* for creation of the message
- * @param inputstream the <CODE>InputStream</CODE> object
+ * @param inputstream the {@code InputStream} object
* that contains the data for a message
- * @return a new <CODE>SOAPMessage</CODE> object containing the
- * data from the given <CODE>InputStream</CODE> object
+ * @return a new {@code SOAPMessage} object containing the
+ * data from the given {@code InputStream} object
* @throws IOException if there is a
* problem in reading data from the input stream
* @throws SOAPException if the message is invalid
Modified: xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/MimeHeader.java
URL: http://svn.apache.org/viewvc/xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/MimeHeader.java?rev=1896561&r1=1896560&r2=1896561&view=diff
==============================================================================
--- xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/MimeHeader.java (original)
+++ xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/MimeHeader.java Fri Dec 31 00:01:16 2021
@@ -17,18 +17,18 @@ package org.apache.xmlbeans.impl.soap;
/**
* An object that stores a MIME header name and its value. One
- * or more <CODE>MimeHeader</CODE> objects may be contained in a
- * <CODE>MimeHeaders</CODE> object.
+ * or more {@code MimeHeader} objects may be contained in a
+ * {@code MimeHeaders} object.
* @see MimeHeaders MimeHeaders
*/
public class MimeHeader {
/**
- * Constructs a <CODE>MimeHeader</CODE> object initialized
+ * Constructs a {@code MimeHeader} object initialized
* with the given name and value.
- * @param name a <CODE>String</CODE> giving the
+ * @param name a {@code String} giving the
* name of the header
- * @param value a <CODE>String</CODE> giving the
+ * @param value a {@code String} giving the
* value of the header
*/
public MimeHeader(String name, String value) {
@@ -37,18 +37,18 @@ public class MimeHeader {
}
/**
- * Returns the name of this <CODE>MimeHeader</CODE>
+ * Returns the name of this {@code MimeHeader}
* object.
- * @return the name of the header as a <CODE>String</CODE>
+ * @return the name of the header as a {@code String}
*/
public String getName() {
return name;
}
/**
- * Returns the value of this <CODE>MimeHeader</CODE>
+ * Returns the value of this {@code MimeHeader}
* object.
- * @return the value of the header as a <CODE>String</CODE>
+ * @return the value of the header as a {@code String}
*/
public String getValue() {
return value;
Modified: xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/MimeHeaders.java
URL: http://svn.apache.org/viewvc/xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/MimeHeaders.java?rev=1896561&r1=1896560&r2=1896561&view=diff
==============================================================================
--- xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/MimeHeaders.java (original)
+++ xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/MimeHeaders.java Fri Dec 31 00:01:16 2021
@@ -19,14 +19,14 @@ import java.util.Iterator;
import java.util.Vector;
/**
- * A container for <CODE>MimeHeader</CODE> objects, which
+ * A container for {@code MimeHeader} objects, which
* represent the MIME headers present in a MIME part of a
- * message.</P>
- *
- * <P>This class is used primarily when an application wants to
+ * message.
+ * <P>
+ * This class is used primarily when an application wants to
* retrieve specific attachments based on certain MIME headers and
* values. This class will most likely be used by implementations
- * of <CODE>AttachmentPart</CODE> and other MIME dependent parts
+ * of {@code AttachmentPart} and other MIME dependent parts
* of the JAXM API.
* @see SOAPMessage#getAttachments() SOAPMessage.getAttachments()
* @see AttachmentPart AttachmentPart
@@ -47,8 +47,8 @@ public class MimeHeaders {
: mimeheader;
}
- for (int i = 0; i < names.length; i++) {
- if (!mimeheader.getName().equalsIgnoreCase(names[i])) {
+ for (String name : names) {
+ if (!mimeheader.getName().equalsIgnoreCase(name)) {
continue;
}
@@ -97,15 +97,15 @@ public class MimeHeaders {
iterator.remove();
}
- private boolean match;
+ private final boolean match;
- private Iterator iterator;
+ private final Iterator iterator;
- private String names[];
+ private final String[] names;
private Object nextHeader;
- MatchingIterator(String as[], boolean flag) {
+ MatchingIterator(String[] as, boolean flag) {
match = flag;
names = as;
@@ -115,8 +115,8 @@ public class MimeHeaders {
/**
* Constructs
- * a default <CODE>MimeHeaders</CODE> object initialized with
- * an empty <CODE>Vector</CODE> object.
+ * a default {@code MimeHeaders} object initialized with
+ * an empty {@code Vector} object.
*/
public MimeHeaders() {
headers = new Vector();
@@ -124,10 +124,10 @@ public class MimeHeaders {
/**
* Returns all of the values for the specified header as an
- * array of <CODE>String</CODE> objects.
+ * array of {@code String} objects.
* @param name the name of the header for which
* values will be returned
- * @return a <CODE>String</CODE> array with all of the values
+ * @return a {@code String} array with all of the values
* for the specified header
* @see #setHeader(java.lang.String, java.lang.String) setHeader(java.lang.String, java.lang.String)
*/
@@ -147,7 +147,7 @@ public class MimeHeaders {
if (vector.size() == 0) {
return null;
} else {
- String as[] = new String[vector.size()];
+ String[] as = new String[vector.size()];
vector.copyInto(as);
@@ -163,9 +163,9 @@ public class MimeHeaders {
*
* <P>Note that RFC822 headers can contain only US-ASCII
* characters.</P>
- * @param name a <CODE>String</CODE> with the
+ * @param name a {@code String} with the
* name of the header for which to search
- * @param value a <CODE>String</CODE> with the
+ * @param value a {@code String} with the
* value that will replace the current value of the
* specified header
* @throws java.lang.IllegalArgumentException if there was a
@@ -202,15 +202,15 @@ public class MimeHeaders {
}
/**
- * Adds a <CODE>MimeHeader</CODE> object with the specified
- * name and value to this <CODE>MimeHeaders</CODE> object's
+ * Adds a {@code MimeHeader} object with the specified
+ * name and value to this {@code MimeHeaders} object's
* list of headers.
*
* <P>Note that RFC822 headers can contain only US-ASCII
* characters.</P>
- * @param name a <CODE>String</CODE> with the
+ * @param name a {@code String} with the
* name of the header to be added
- * @param value a <CODE>String</CODE> with the
+ * @param value a {@code String} with the
* value of the header to be added
* @throws java.lang.IllegalArgumentException if
* there was a problem in the mime header name or value
@@ -239,9 +239,9 @@ public class MimeHeaders {
}
/**
- * Remove all <CODE>MimeHeader</CODE> objects whose name
+ * Remove all {@code MimeHeader} objects whose name
* matches the the given name.
- * @param name a <CODE>String</CODE> with the
+ * @param name a {@code String} with the
* name of the header for which to search
*/
public void removeHeader(String name) {
@@ -256,54 +256,54 @@ public class MimeHeaders {
}
/**
- * Removes all the header entries from this <CODE>
- * MimeHeaders</CODE> object.
+ * Removes all the header entries from this {@code
+ * MimeHeaders} object.
*/
public void removeAllHeaders() {
headers.removeAllElements();
}
/**
- * Returns all the headers in this <CODE>MimeHeaders</CODE>
+ * Returns all the headers in this {@code MimeHeaders}
* object.
- * @return an <CODE>Iterator</CODE> object over this <CODE>
- * MimeHeaders</CODE> object's list of <CODE>
- * MimeHeader</CODE> objects
+ * @return an {@code Iterator} object over this {@code
+ * MimeHeaders} object's list of {@code
+ * MimeHeader} objects
*/
public Iterator getAllHeaders() {
return headers.iterator();
}
/**
- * Returns all the <CODE>MimeHeader</CODE> objects whose
+ * Returns all the {@code MimeHeader} objects whose
* name matches a name in the given array of names.
- * @param names an array of <CODE>String</CODE>
+ * @param names an array of {@code String}
* objects with the names for which to search
- * @return an <CODE>Iterator</CODE> object over the <CODE>
- * MimeHeader</CODE> objects whose name matches one of the
+ * @return an {@code Iterator} object over the {@code
+ * MimeHeader} objects whose name matches one of the
* names in the given list
*/
- public Iterator getMatchingHeaders(String names[]) {
+ public Iterator getMatchingHeaders(String[] names) {
return new MatchingIterator(names, true);
}
/**
- * Returns all of the <CODE>MimeHeader</CODE> objects whose
+ * Returns all of the {@code MimeHeader} objects whose
* name does not match a name in the given array of names.
- * @param names an array of <CODE>String</CODE>
+ * @param names an array of {@code String}
* objects with the names for which to search
- * @return an <CODE>Iterator</CODE> object over the <CODE>
- * MimeHeader</CODE> objects whose name does not match one
+ * @return an {@code Iterator} object over the {@code
+ * MimeHeader} objects whose name does not match one
* of the names in the given list
*/
- public Iterator getNonMatchingHeaders(String names[]) {
+ public Iterator getNonMatchingHeaders(String[] names) {
return new MatchingIterator(names, false);
}
// fixme: does this need to be a Vector? Will a non-synchronized impl of
// List do?
/**
- * A <code>Vector</code> containing the headers as <code>MimeHeader</code>
+ * A {@code Vector} containing the headers as {@code MimeHeader}
* instances.
*/
protected Vector headers;
Modified: xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/Name.java
URL: http://svn.apache.org/viewvc/xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/Name.java?rev=1896561&r1=1896560&r2=1896561&view=diff
==============================================================================
--- xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/Name.java (original)
+++ xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/Name.java Fri Dec 31 00:01:16 2021
@@ -27,33 +27,33 @@ package org.apache.xmlbeans.impl.soap;
* </PRE>
* ("xmlns" stands for "XML namespace".)
* The following
- * shows what the methods in the <code>Name</code> interface will return.
+ * shows what the methods in the {@code Name} interface will return.
* <UL>
- * <LI><code>getQualifiedName</code> will return "prefix:LocalName" =
+ * <LI>{@code getQualifiedName} will return "prefix:LocalName" =
* "WOMBAT:GetLastTradePrice"
- * <LI><code>getURI</code> will return "http://www.wombat.org/trader"
- * <LI><code>getLocalName</code> will return "GetLastTracePrice"
- * <LI><code>getPrefix</code> will return "WOMBAT"
+ * <LI>{@code getURI} will return "http://www.wombat.org/trader"
+ * <LI>{@code getLocalName} will return "GetLastTracePrice"
+ * <LI>{@code getPrefix} will return "WOMBAT"
* </UL>
* <P>
* XML namespaces are used to disambiguate SOAP identifiers from
* application-specific identifiers.
* <P>
- * <code>Name</code> objects are created using the method
- * <code>SOAPEnvelope.createName</code>, which has two versions.
- * One method creates <code>Name</code> objects with
+ * {@code Name} objects are created using the method
+ * {@code SOAPEnvelope.createName}, which has two versions.
+ * One method creates {@code Name} objects with
* a local name, a namespace prefix, and a namespace URI.
- * and the second creates <code>Name</code> objects with just a local name.
+ * and the second creates {@code Name} objects with just a local name.
* The following line of
- * code, in which <i>se</i> is a <code>SOAPEnvelope</code> object, creates a new
- * <code>Name</code> object with all three.
+ * code, in which <i>se</i> is a {@code SOAPEnvelope} object, creates a new
+ * {@code Name} object with all three.
* <PRE>
* Name name = se.createName("GetLastTradePrice", "WOMBAT",
* "http://www.wombat.org/trader");
* </PRE>
- * The following line of code gives an example of how a <code>Name</code> object
- * can be used. The variable <i>element</i> is a <code>SOAPElement</code> object.
- * This code creates a new <code>SOAPElement</code> object with the given name and
+ * The following line of code gives an example of how a {@code Name} object
+ * can be used. The variable <i>element</i> is a {@code SOAPElement} object.
+ * This code creates a new {@code SOAPElement} object with the given name and
* adds it to <i>element</i>.
* <PRE>
* element.addChildElement(name);
@@ -62,7 +62,7 @@ package org.apache.xmlbeans.impl.soap;
public interface Name {
/**
- * Gets the local name part of the XML name that this <code>Name</code>
+ * Gets the local name part of the XML name that this {@code Name}
* object represents.
* @return a string giving the local name
*/
@@ -70,21 +70,21 @@ public interface Name {
/**
* Gets the namespace-qualified name of the XML name that this
- * <code>Name</code> object represents.
+ * {@code Name} object represents.
* @return the namespace-qualified name as a string
*/
public abstract String getQualifiedName();
/**
* Returns the prefix associated with the namespace for the XML
- * name that this <code>Name</code> object represents.
+ * name that this {@code Name} object represents.
* @return the prefix as a string
*/
public abstract String getPrefix();
/**
* Returns the URI of the namespace for the XML
- * name that this <code>Name</code> object represents.
+ * name that this {@code Name} object represents.
* @return the URI as a string
*/
public abstract String getURI();
Modified: xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/Node.java
URL: http://svn.apache.org/viewvc/xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/Node.java?rev=1896561&r1=1896560&r2=1896561&view=diff
==============================================================================
--- xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/Node.java (original)
+++ xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/Node.java Fri Dec 31 00:01:16 2021
@@ -24,20 +24,20 @@ package org.apache.xmlbeans.impl.soap;
public interface Node extends org.w3c.dom.Node {
/**
- * Returns the the value of the immediate child of this <code>Node</code>
+ * Returns the the value of the immediate child of this {@code Node}
* object if a child exists and its value is text.
- * @return a <code>String</code> with the text of the immediate child of
- * this <code>Node</code> object if (1) there is a child and
- * (2) the child is a <code>Text</code> object;
- * <code>null</code> otherwise
+ * @return a {@code String} with the text of the immediate child of
+ * this {@code Node} object if (1) there is a child and
+ * (2) the child is a {@code Text} object;
+ * {@code null} otherwise
*/
public abstract String getValue();
/**
- * Sets the parent of this <code>Node</code> object to the given
- * <code>SOAPElement</code> object.
- * @param parent the <code>SOAPElement</code> object to be set as
- * the parent of this <code>Node</code> object
+ * Sets the parent of this {@code Node} object to the given
+ * {@code SOAPElement} object.
+ * @param parent the {@code SOAPElement} object to be set as
+ * the parent of this {@code Node} object
* @throws SOAPException if there is a problem in setting the
* parent to the given element
* @see #getParentElement() getParentElement()
@@ -46,32 +46,32 @@ public interface Node extends org.w3c.do
throws SOAPException;
/**
- * Returns the parent element of this <code>Node</code> object.
- * This method can throw an <code>UnsupportedOperationException</code>
+ * Returns the parent element of this {@code Node} object.
+ * This method can throw an {@code UnsupportedOperationException}
* if the tree is not kept in memory.
- * @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
+ * @return the {@code SOAPElement} object that is the parent of
+ * this {@code Node} object or {@code null} if this
+ * {@code Node} 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();
/**
- * Removes this <code>Node</code> object from the tree. Once
+ * Removes this {@code Node} object from the tree. Once
* removed, this node can be garbage collected if there are no
* application references to it.
*/
public abstract void detachNode();
/**
- * Notifies the implementation that this <code>Node</code>
+ * Notifies the implementation that this {@code Node}
* object is no longer being used by the application and that the
* implementation is free to reuse this object for nodes that may
* be created later.
* <P>
- * Calling the method <code>recycleNode</code> implies that the method
- * <code>detachNode</code> has been called previously.
+ * Calling the method {@code recycleNode} implies that the method
+ * {@code detachNode} has been called previously.
*/
public abstract void recycleNode();
Modified: xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/SOAPBody.java
URL: http://svn.apache.org/viewvc/xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/SOAPBody.java?rev=1896561&r1=1896560&r2=1896561&view=diff
==============================================================================
--- xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/SOAPBody.java (original)
+++ xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/SOAPBody.java Fri Dec 31 00:01:16 2021
@@ -24,102 +24,102 @@ import java.util.Locale;
* element in a SOAP message. A SOAP body element consists of XML data
* that affects the way the application-specific content is processed.
* <P>
- * A <code>SOAPBody</code> object contains <code>SOAPBodyElement</code>
+ * A {@code SOAPBody} object contains {@code SOAPBodyElement}
* objects, which have the content for the SOAP body.
- * A <code>SOAPFault</code> object, which carries status and/or
- * error information, is an example of a <code>SOAPBodyElement</code> object.
+ * A {@code SOAPFault} object, which carries status and/or
+ * error information, is an example of a {@code SOAPBodyElement} object.
* @see SOAPFault SOAPFault
*/
public interface SOAPBody extends SOAPElement {
/**
- * Creates a new <code>SOAPFault</code> object and adds it to
- * this <code>SOAPBody</code> object.
- * @return the new <code>SOAPFault</code> object
+ * Creates a new {@code SOAPFault} object and adds it to
+ * this {@code SOAPBody} object.
+ * @return the new {@code SOAPFault} object
* @throws SOAPException if there is a SOAP error
*/
- public abstract SOAPFault addFault() throws SOAPException;
+ SOAPFault addFault() throws SOAPException;
/**
- * Indicates whether a <code>SOAPFault</code> object exists in
- * this <code>SOAPBody</code> object.
- * @return <code>true</code> if a <code>SOAPFault</code> object exists in
- * this <code>SOAPBody</code> object; <code>false</code>
+ * Indicates whether a {@code SOAPFault} object exists in
+ * this {@code SOAPBody} object.
+ * @return {@code true} if a {@code SOAPFault} object exists in
+ * this {@code SOAPBody} object; {@code false}
* otherwise
*/
- public abstract boolean hasFault();
+ boolean hasFault();
/**
- * Returns the <code>SOAPFault</code> object in this <code>SOAPBody</code>
+ * Returns the {@code SOAPFault} object in this {@code SOAPBody}
* object.
- * @return the <code>SOAPFault</code> object in this <code>SOAPBody</code>
+ * @return the {@code SOAPFault} object in this {@code SOAPBody}
* object
*/
- public abstract SOAPFault getFault();
+ SOAPFault getFault();
/**
- * Creates a new <code>SOAPBodyElement</code> object with the
- * specified name and adds it to this <code>SOAPBody</code> object.
- * @param name a <code>Name</code> object with the name for the new
- * <code>SOAPBodyElement</code> object
- * @return the new <code>SOAPBodyElement</code> object
+ * Creates a new {@code SOAPBodyElement} object with the
+ * specified name and adds it to this {@code SOAPBody} object.
+ * @param name a {@code Name} object with the name for the new
+ * {@code SOAPBodyElement} object
+ * @return the new {@code SOAPBodyElement} object
* @throws SOAPException if a SOAP error occurs
*/
- public abstract SOAPBodyElement addBodyElement(Name name)
+ SOAPBodyElement addBodyElement(Name name)
throws SOAPException;
/**
- * Creates a new <code>SOAPFault</code> object and adds it to this
- * <code>SOAPBody</code> object. The new <code>SOAPFault</code> will have a
- * <code>faultcode</code> element that is set to the <code>faultCode</code>
- * parameter and a <code>faultstring</code> set to <code>faultstring</code>
- * and localized to <code>locale</code>.
+ * Creates a new {@code SOAPFault} object and adds it to this
+ * {@code SOAPBody} object. The new {@code SOAPFault} will have a
+ * {@code faultcode} element that is set to the {@code faultCode}
+ * parameter and a {@code faultstring} set to {@code faultstring}
+ * and localized to {@code locale}.
*
- * @param faultCode a <code>Name</code> object giving the fault code to be
+ * @param faultCode a {@code Name} object giving the fault code to be
* set; must be one of the fault codes defined in the SOAP 1.1
* specification and of type QName
- * @param faultString a <code>String</code> giving an explanation of the
+ * @param faultString a {@code String} giving an explanation of the
* fault
- * @param locale a <code>Locale</code> object indicating the native language
- * of the <ocde>faultString</code>
- * @return the new <code>SOAPFault</code> object
+ * @param locale a {@code Locale} object indicating the native language
+ * of the {@code faultString}
+ * @return the new {@code SOAPFault} object
* @throws SOAPException if there is a SOAP error
*/
- public abstract SOAPFault addFault(Name faultCode,
- String faultString,
- Locale locale) throws SOAPException;
+ SOAPFault addFault(Name faultCode,
+ String faultString,
+ Locale locale) throws SOAPException;
/**
- * Creates a new <code>SOAPFault</code> object and adds it to this
- * <code>SOAPBody</code> object. The new <code>SOAPFault</code> will have a
- * <code>faultcode</code> element that is set to the <code>faultCode</code>
- * parameter and a <code>faultstring</code> set to <code>faultstring</code>.
+ * Creates a new {@code SOAPFault} object and adds it to this
+ * {@code SOAPBody} object. The new {@code SOAPFault} will have a
+ * {@code faultcode} element that is set to the {@code faultCode}
+ * parameter and a {@code faultstring} set to {@code faultstring}.
*
- * @param faultCode a <code>Name</code> object giving the fault code to be
+ * @param faultCode a {@code Name} object giving the fault code to be
* set; must be one of the fault codes defined in the SOAP 1.1
* specification and of type QName
- * @param faultString a <code>String</code> giving an explanation of the
+ * @param faultString a {@code String} giving an explanation of the
* fault
- * @return the new <code>SOAPFault</code> object
+ * @return the new {@code SOAPFault} object
* @throws SOAPException if there is a SOAP error
*/
- public abstract SOAPFault addFault(Name faultCode, String faultString) throws SOAPException;
+ SOAPFault addFault(Name faultCode, String faultString) throws SOAPException;
/**
- * Adds the root node of the DOM <code>Document</code> to this
- * <code>SOAPBody</code> object.
+ * Adds the root node of the DOM {@code Document} to this
+ * {@code SOAPBody} object.
* <p>
- * Calling this method invalidates the <code>document</code> parameter. The
+ * Calling this method invalidates the {@code document} parameter. The
* client application should discard all references to this
- * <code>Document</code> and its contents upon calling
- * <code>addDocument</code>. The behavior of an application that continues
+ * {@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 <code>Document</code> object whose root node will be
- * added to this <code>SOAPBody</code>
- * @return the <code>SOAPBodyElement</code> that represents the root node
+ * @param document 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
- * @throws SOAPException if the <code>Document</code> cannot be added
+ * @throws SOAPException if the {@code Document} cannot be added
*/
- public abstract SOAPBodyElement addDocument(Document document) throws SOAPException;
+ SOAPBodyElement addDocument(Document document) throws SOAPException;
}
Modified: xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/SOAPBodyElement.java
URL: http://svn.apache.org/viewvc/xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/SOAPBodyElement.java?rev=1896561&r1=1896560&r2=1896561&view=diff
==============================================================================
--- xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/SOAPBodyElement.java (original)
+++ xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/SOAPBodyElement.java Fri Dec 31 00:01:16 2021
@@ -16,15 +16,15 @@
package org.apache.xmlbeans.impl.soap;
/**
- * A <code>SOAPBodyElement</code> object represents the contents in
- * a <code>SOAPBody</code> object. The <code>SOAPFault</code> interface
- * is a <code>SOAPBodyElement</code> object that has been defined.
+ * A {@code SOAPBodyElement} object represents the contents in
+ * a {@code SOAPBody} object. The {@code SOAPFault} interface
+ * is a {@code SOAPBodyElement} object that has been defined.
* <P>
- * A new <code>SOAPBodyElement</code> object can be created and added
- * to a <code>SOAPBody</code> object with the <code>SOAPBody</code>
- * method <code>addBodyElement</code>. In the following line of code,
- * <code>sb</code> is a <code>SOAPBody</code> object, and
- * <code>myName</code> is a <code>Name</code> object.
+ * A new {@code SOAPBodyElement} object can be created and added
+ * to a {@code SOAPBody} object with the {@code SOAPBody}
+ * method {@code addBodyElement}. In the following line of code,
+ * {@code sb} is a {@code SOAPBody} object, and
+ * {@code myName} is a {@code Name} object.
* <PRE>
* SOAPBodyElement sbe = sb.addBodyElement(myName);
* </PRE>
Modified: xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/SOAPConnection.java
URL: http://svn.apache.org/viewvc/xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/SOAPConnection.java?rev=1896561&r1=1896560&r2=1896561&view=diff
==============================================================================
--- xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/SOAPConnection.java (original)
+++ xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/SOAPConnection.java Fri Dec 31 00:01:16 2021
@@ -19,15 +19,15 @@ package org.apache.xmlbeans.impl.soap;
* 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
+ * A client can obtain a {@code SOAPConnection} object simply by
* calling the following static method.
* <pre>
*
* SOAPConnection con = SOAPConnection.newInstance();
* </pre>
- * A <code>SOAPConnection</code> object can be used to send messages
+ * A {@code SOAPConnection} 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
+ * messages are sent using the method {@code call}, which sends the
* message and then waits until it gets a reply.
*/
public abstract class SOAPConnection {
@@ -37,15 +37,15 @@ public abstract class SOAPConnection {
/**
* 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}
* object to be sent
- * @param endpoint an <code>Object</code> that identifies
+ * @param endpoint an {@code Object} 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
+ * {@code java.lang.String},
+ * {@code java.net.URL}, and when JAXM is present
+ * {@code javax.xml.messaging.URLEndpoint}
+ * @return the {@code SOAPMessage} object that is the
* response to the message that was sent
* @throws SOAPException if there is a SOAP error
*/
@@ -53,7 +53,7 @@ public abstract class SOAPConnection {
throws SOAPException;
/**
- * Closes this <CODE>SOAPConnection</CODE> object.
+ * Closes this {@code SOAPConnection} object.
* @throws SOAPException if there is a SOAP error
*/
public abstract void close() throws SOAPException;
Modified: xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/SOAPConnectionFactory.java
URL: http://svn.apache.org/viewvc/xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/SOAPConnectionFactory.java?rev=1896561&r1=1896560&r2=1896561&view=diff
==============================================================================
--- xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/SOAPConnectionFactory.java (original)
+++ xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/SOAPConnectionFactory.java Fri Dec 31 00:01:16 2021
@@ -16,25 +16,25 @@
package org.apache.xmlbeans.impl.soap;
/**
- * A factory for creating <code>SOAPConnection</code> objects. Implementation of
- * this class is optional. If <code>SOAPConnectionFactory.newInstance()</code>
- * throws an <code>UnsupportedOperationException</code> then the implementation
+ * A factory for creating {@code SOAPConnection} objects. Implementation of
+ * this class is optional. If {@code SOAPConnectionFactory.newInstance()}
+ * throws an {@code UnsupportedOperationException} then the implementation
* does not support the SAAJ communication infrastructure. Otherwise
- * <code>SOAPConnection</code> objects can be created by calling
- * <code>createConnection()</code> on the newly created
- * <code>SOAPConnectionFactory</code> object.
+ * {@code SOAPConnection} objects can be created by calling
+ * {@code createConnection()} on the newly created
+ * {@code SOAPConnectionFactory} object.
*/
public abstract class SOAPConnectionFactory {
public SOAPConnectionFactory() {}
/**
- * Creates an instance of the default <CODE>
- * SOAPConnectionFactory</CODE> object.
- * @return a new instance of a default <CODE>
- * SOAPConnectionFactory</CODE> object
+ * Creates an instance of the default {@code
+ * SOAPConnectionFactory} object.
+ * @return a new instance of a default {@code
+ * SOAPConnectionFactory} object
* @throws SOAPException if there was an error creating
- * the <CODE>SOAPConnectionFactory
+ * the {@code SOAPConnectionFactory}
* @throws UnsupportedOperationException if newInstance is not supported.
*/
public static SOAPConnectionFactory newInstance()
@@ -50,10 +50,10 @@ public abstract class SOAPConnectionFact
}
/**
- * Create a new <CODE>SOAPConnection</CODE>.
- * @return the new <CODE>SOAPConnection</CODE> object.
+ * Create a new {@code SOAPConnection}.
+ * @return the new {@code SOAPConnection} object.
* @throws SOAPException if there was an exception
- * creating the <CODE>SOAPConnection</CODE> object.
+ * creating the {@code SOAPConnection} object.
*/
public abstract SOAPConnection createConnection() throws SOAPException;
Modified: xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/SOAPElement.java
URL: http://svn.apache.org/viewvc/xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/SOAPElement.java?rev=1896561&r1=1896560&r2=1896561&view=diff
==============================================================================
--- xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/SOAPElement.java (original)
+++ xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/SOAPElement.java Fri Dec 31 00:01:16 2021
@@ -19,158 +19,158 @@ import java.util.Iterator;
/**
* An object representing the contents in a
- * <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>SOAPFault</code> object. It is
+ * {@code SOAPBody} object, the contents in a {@code SOAPHeader}
+ * object, the content that can follow the {@code SOAPBody} object in a
+ * {@code SOAPEnvelope} object, or what can follow the detail element
+ * in a {@code SOAPFault} object. It is
* the base class for all of the classes that represent the SOAP objects as
* defined in the SOAP specification.
*/
public interface SOAPElement extends Node, org.w3c.dom.Element {
/**
- * Creates a new <code>SOAPElement</code> object initialized with the
- * given <code>Name</code> object and adds the new element to this
- * <code>SOAPElement</code> object.
- * @param name a <code>Name</code> object with the XML name for the
+ * Creates a new {@code SOAPElement} object initialized with the
+ * given {@code Name} object and adds the new element to this
+ * {@code SOAPElement} object.
+ * @param name a {@code Name} object with the XML name for the
* new element
- * @return the new <code>SOAPElement</code> object that was created
+ * @return the new {@code SOAPElement} object that was created
* @throws SOAPException if there is an error in creating the
- * <code>SOAPElement</code> object
+ * {@code SOAPElement} object
*/
- public abstract SOAPElement addChildElement(Name name) throws SOAPException;
+ SOAPElement addChildElement(Name name) throws SOAPException;
/**
- * Creates a new <code>SOAPElement</code> object initialized with the
- * given <code>String</code> object and adds the new element to this
- * <code>SOAPElement</code> object.
- * @param localName a <code>String</code> giving the local name for
+ * Creates a new {@code SOAPElement} object initialized with the
+ * given {@code String} object and adds the new element to this
+ * {@code SOAPElement} object.
+ * @param localName a {@code String} giving the local name for
* the element
- * @return the new <code>SOAPElement</code> object that was created
+ * @return the new {@code SOAPElement} object that was created
* @throws SOAPException if there is an error in creating the
- * <code>SOAPElement</code> object
+ * {@code SOAPElement} object
*/
- public abstract SOAPElement addChildElement(String localName)
+ SOAPElement addChildElement(String localName)
throws SOAPException;
/**
- * Creates a new <code>SOAPElement</code> object initialized with the
+ * Creates a new {@code SOAPElement} object initialized with the
* specified local name and prefix and adds the new element to this
- * <code>SOAPElement</code> object.
- * @param localName a <code>String</code> giving the local name for
+ * {@code SOAPElement} object.
+ * @param localName a {@code String} giving the local name for
* the new element
- * @param prefix a <code>String</code> giving the namespace prefix for
+ * @param prefix a {@code String} giving the namespace prefix for
* the new element
- * @return the new <code>SOAPElement</code> object that was created
+ * @return the new {@code SOAPElement} object that was created
* @throws SOAPException if there is an error in creating the
- * <code>SOAPElement</code> object
+ * {@code SOAPElement} object
*/
- public abstract SOAPElement addChildElement(String localName, String prefix)
+ SOAPElement addChildElement(String localName, String prefix)
throws SOAPException;
/**
- * Creates a new <code>SOAPElement</code> object initialized with the
+ * Creates a new {@code SOAPElement} object initialized with the
* specified local name, prefix, and URI and adds the new element to this
- * <code>SOAPElement</code> object.
- * @param localName a <code>String</code> giving the local name for
+ * {@code SOAPElement} object.
+ * @param localName a {@code String} giving the local name for
* the new element
- * @param prefix a <code>String</code> giving the namespace prefix for
+ * @param prefix a {@code String} giving the namespace prefix for
* the new element
- * @param uri a <code>String</code> giving the URI of the namespace
+ * @param uri a {@code String} giving the URI of the namespace
* to which the new element belongs
- * @return the new <code>SOAPElement</code> object that was created
+ * @return the new {@code SOAPElement} object that was created
* @throws SOAPException if there is an error in creating the
- * <code>SOAPElement</code> object
+ * {@code SOAPElement} object
*/
- public abstract SOAPElement addChildElement(
+ SOAPElement addChildElement(
String localName, String prefix, String uri) throws SOAPException;
/**
- * Add a <code>SOAPElement</code> as a child of this
- * <code>SOAPElement</code> instance. The <code>SOAPElement</code>
+ * Add a {@code SOAPElement} as a child of this
+ * {@code SOAPElement} instance. The {@code SOAPElement}
* is expected to be created by a
- * <code>SOAPElementFactory</code>. Callers should not rely on the
+ * {@code SOAPElementFactory}. Callers should not rely on the
* element instance being added as is into the XML
* tree. Implementations could end up copying the content
- * of the <code>SOAPElement</code> passed into an instance of
- * a different <code>SOAPElement</code> implementation. For
- * instance if <code>addChildElement()</code> is called on a
- * <code>SOAPHeader</code>, <code>element</code> will be copied
- * into an instance of a <code>SOAPHeaderElement</code>.
+ * of the {@code SOAPElement} passed into an instance of
+ * a different {@code SOAPElement} implementation. For
+ * instance if {@code addChildElement()} is called on a
+ * {@code SOAPHeader}, {@code element} will be copied
+ * into an instance of a {@code SOAPHeaderElement}.
*
- * <P>The fragment rooted in <code>element</code> is either added
+ * <P>The fragment rooted in {@code element} is either added
* as a whole or not at all, if there was an error.
*
- * <P>The fragment rooted in <code>element</code> cannot contain
+ * <P>The fragment rooted in {@code element} cannot contain
* elements named "Envelope", "Header" or "Body" and in the SOAP
* namespace. Any namespace prefixes present in the fragment
* should be fully resolved using appropriate namespace
* declarations within the fragment itself.
- * @param element the <code>SOAPElement</code> to be added as a
+ * @param element the {@code SOAPElement} to be added as a
* new child
* @return an instance representing the new SOAP element that was
* actually added to the tree.
* @throws SOAPException if there was an error in adding this
* element as a child
*/
- public abstract SOAPElement addChildElement(SOAPElement element)
+ SOAPElement addChildElement(SOAPElement element)
throws SOAPException;
/**
- * Creates a new <code>Text</code> object initialized with the given
- * <code>String</code> and adds it to this <code>SOAPElement</code> object.
- * @param text a <code>String</code> object with the textual content to be added
- * @return the <code>SOAPElement</code> object into which
- * the new <code>Text</code> object was inserted
+ * Creates a new {@code Text} object initialized with the given
+ * {@code String} and adds it to this {@code SOAPElement} object.
+ * @param text a {@code String} object with the textual content to be added
+ * @return the {@code SOAPElement} object into which
+ * the new {@code Text} object was inserted
* @throws SOAPException if there is an error in creating the
- * new <code>Text</code> object
+ * new {@code Text} object
*/
- public abstract SOAPElement addTextNode(String text) throws SOAPException;
+ SOAPElement addTextNode(String text) throws SOAPException;
/**
* Adds an attribute with the specified name and value to this
- * <code>SOAPElement</code> object.
+ * {@code SOAPElement} object.
* <p>
- * @param name a <code>Name</code> object with the name of the attribute
- * @param value a <code>String</code> giving the value of the attribute
- * @return the <code>SOAPElement</code> object into which the attribute was
+ * @param name a {@code Name} object with the name of the attribute
+ * @param value a {@code String} giving the value of the attribute
+ * @return the {@code SOAPElement} object into which the attribute was
* inserted
* @throws SOAPException if there is an error in creating the
* Attribute
*/
- public abstract SOAPElement addAttribute(Name name, String value)
+ SOAPElement addAttribute(Name name, String value)
throws SOAPException;
/**
* Adds a namespace declaration with the specified prefix and URI to this
- * <code>SOAPElement</code> object.
+ * {@code SOAPElement} object.
* <p>
- * @param prefix a <code>String</code> giving the prefix of the namespace
- * @param uri a <CODE>String</CODE> giving
+ * @param prefix a {@code String} giving the prefix of the namespace
+ * @param uri a {@code String} giving
* the prefix of the namespace
- * @return the <code>SOAPElement</code> object into which this
+ * @return the {@code SOAPElement} object into which this
* namespace declaration was inserted.
* @throws SOAPException if there is an error in creating the
* namespace
*/
- public abstract SOAPElement addNamespaceDeclaration(
+ SOAPElement addNamespaceDeclaration(
String prefix, String uri) throws SOAPException;
/**
* Returns the value of the attribute with the specified
* name.
- * @param name a <CODE>Name</CODE> object with
+ * @param name a {@code Name} object with
* the name of the attribute
- * @return a <CODE>String</CODE> giving the value of the
+ * @return a {@code String} giving the value of the
* specified attribute
*/
- public abstract String getAttributeValue(Name name);
+ String getAttributeValue(Name name);
/**
* Returns an iterator over all of the attribute names in
- * this <CODE>SOAPElement</CODE> object. The iterator can be
+ * this {@code SOAPElement} object. The iterator can be
* used to get the attribute names, which can then be passed to
- * the method <CODE>getAttributeValue</CODE> to retrieve the
+ * the method {@code getAttributeValue} to retrieve the
* value of each attribute.
* @return an iterator over the names of the attributes
*/
@@ -180,109 +180,109 @@ public interface SOAPElement extends Nod
* Returns the URI of the namespace that has the given
* prefix.
*
- * @param prefix a <CODE>String</CODE> giving
+ * @param prefix a {@code String} giving
* the prefix of the namespace for which to search
- * @return a <CODE>String</CODE> with the uri of the namespace
+ * @return a {@code String} with the uri of the namespace
* that has the given prefix
*/
- public abstract String getNamespaceURI(String prefix);
+ String getNamespaceURI(String prefix);
/**
* Returns an iterator of namespace prefixes. The iterator
* can be used to get the namespace prefixes, which can then be
- * passed to the method <CODE>getNamespaceURI</CODE> to retrieve
+ * passed to the method {@code getNamespaceURI} to retrieve
* the URI of each namespace.
* @return an iterator over the namespace prefixes in this
- * <CODE>SOAPElement</CODE> object
+ * {@code SOAPElement} object
*/
- public abstract Iterator getNamespacePrefixes();
+ Iterator getNamespacePrefixes();
/**
- * Returns the name of this <CODE>SOAPElement</CODE>
+ * Returns the name of this {@code SOAPElement}
* object.
- * @return a <CODE>Name</CODE> object with the name of this
- * <CODE>SOAPElement</CODE> object
+ * @return a {@code Name} object with the name of this
+ * {@code SOAPElement} object
*/
- public abstract Name getElementName();
+ Name getElementName();
/**
* Removes the attribute with the specified name.
- * @param name the <CODE>Name</CODE> object with
+ * @param name the {@code Name} object with
* the name of the attribute to be removed
- * @return <CODE>true</CODE> if the attribute was removed
- * successfully; <CODE>false</CODE> if it was not
+ * @return {@code true} if the attribute was removed
+ * successfully; {@code false} if it was not
*/
- public abstract boolean removeAttribute(Name name);
+ boolean removeAttribute(Name name);
/**
* Removes the namespace declaration corresponding to the
* given prefix.
- * @param prefix a <CODE>String</CODE> giving
+ * @param prefix a {@code String} giving
* the prefix for which to search
- * @return <CODE>true</CODE> if the namespace declaration was
- * removed successfully; <CODE>false</CODE> if it was
+ * @return {@code true} if the namespace declaration was
+ * removed successfully; {@code false} if it was
* not
*/
- public abstract boolean removeNamespaceDeclaration(String prefix);
+ boolean removeNamespaceDeclaration(String prefix);
/**
* Returns an iterator over all the immediate content of
- * this element. This includes <CODE>Text</CODE> objects as well
- * as <CODE>SOAPElement</CODE> objects.
- * @return an iterator with the content of this <CODE>
- * SOAPElement</CODE> object
+ * this element. This includes {@code Text} objects as well
+ * as {@code SOAPElement} objects.
+ * @return an iterator with the content of this {@code
+ * SOAPElement} object
*/
- public abstract Iterator getChildElements();
+ Iterator getChildElements();
/**
* Returns an iterator over all the child elements with the
* specified name.
- * @param name a <CODE>Name</CODE> object with
+ * @param name a {@code Name} object with
* the name of the child elements to be returned
- * @return an <CODE>Iterator</CODE> object over all the elements
- * in this <CODE>SOAPElement</CODE> object with the
+ * @return an {@code Iterator} object over all the elements
+ * in this {@code SOAPElement} object with the
* specified name
*/
- public abstract Iterator getChildElements(Name name);
+ Iterator getChildElements(Name name);
/**
- * Sets the encoding style for this <CODE>SOAPElement</CODE>
+ * Sets the encoding style for this {@code SOAPElement}
* object to one specified.
- * @param encodingStyle a <CODE>String</CODE>
+ * @param encodingStyle a {@code String}
* giving the encoding style
* @throws java.lang.IllegalArgumentException if
* there was a problem in the encoding style being set.
* @see #getEncodingStyle() getEncodingStyle()
*/
- public abstract void setEncodingStyle(String encodingStyle)
+ void setEncodingStyle(String encodingStyle)
throws SOAPException;
/**
- * Returns the encoding style for this <CODE>
- * SOAPElement</CODE> object.
- * @return a <CODE>String</CODE> giving the encoding style
+ * Returns the encoding style for this {@code
+ * SOAPElement} object.
+ * @return a {@code String} giving the encoding style
* @see #setEncodingStyle(java.lang.String) setEncodingStyle(java.lang.String)
*/
- public abstract String getEncodingStyle();
+ String getEncodingStyle();
/**
- * Detaches all children of this <code>SOAPElement</code>.
+ * Detaches all children of this {@code SOAPElement}.
* <p>
* This method is useful for rolling back the construction of partially
- * completed <code>SOAPHeaders</code> and <code>SOAPBodys</code> in
+ * completed {@code SOAPHeaders} and {@code SOAPBodys} in
* reparation for sending a fault when an error condition is detected. It is
* also useful for recycling portions of a document within a SOAP message.
*/
- public abstract void removeContents();
+ void removeContents();
/**
- * Returns an <code>Iterator</code> over the namespace prefix
- * <code>String</code>s visible to this element. The prefixes returned by
- * this iterator can be passed to the method <code>getNamespaceURI()</code>
+ * Returns an {@code Iterator} over the namespace prefix
+ * {@code String}s visible to this element. The prefixes returned by
+ * this iterator can be passed to the method {@code getNamespaceURI()}
* to retrieve the URI of each namespace.
*
* @return an iterator over the namespace prefixes are within scope of this
- * <code>SOAPElement</code> object
+ * {@code SOAPElement} object
*/
- public abstract Iterator getVisibleNamespacePrefixes();
+ Iterator getVisibleNamespacePrefixes();
}
Modified: xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/SOAPEnvelope.java
URL: http://svn.apache.org/viewvc/xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/SOAPEnvelope.java?rev=1896561&r1=1896560&r2=1896561&view=diff
==============================================================================
--- xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/SOAPEnvelope.java (original)
+++ xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/SOAPEnvelope.java Fri Dec 31 00:01:16 2021
@@ -17,25 +17,25 @@ package org.apache.xmlbeans.impl.soap;
/**
* The container for the SOAPHeader and SOAPBody portions of a
- * <CODE>SOAPPart</CODE> object. By default, a <CODE>
- * SOAPMessage</CODE> object is created with a <CODE>
- * SOAPPart</CODE> object that has a <CODE>SOAPEnvelope</CODE>
- * object. The <CODE>SOAPEnvelope</CODE> object by default has an
- * empty <CODE>SOAPBody</CODE> object and an empty <CODE>
- * SOAPHeader</CODE> object. The <CODE>SOAPBody</CODE> object is
- * required, and the <CODE>SOAPHeader</CODE> object, though
- * optional, is used in the majority of cases. If the <CODE>
- * SOAPHeader</CODE> object is not needed, it can be deleted,
- * which is shown later.</P>
+ * {@code SOAPPart} object. By default, a {@code
+ * SOAPMessage} object is created with a {@code
+ * SOAPPart} object that has a {@code SOAPEnvelope}
+ * object. The {@code SOAPEnvelope} object by default has an
+ * empty {@code SOAPBody} object and an empty {@code
+ * SOAPHeader} object. The {@code SOAPBody} object is
+ * required, and the {@code SOAPHeader} object, though
+ * optional, is used in the majority of cases. If the {@code
+ * SOAPHeader} object is not needed, it can be deleted,
+ * which is shown later.
*
- * <P>A client can access the <CODE>SOAPHeader</CODE> and <CODE>
- * SOAPBody</CODE> objects by calling the methods <CODE>
- * SOAPEnvelope.getHeader</CODE> and <CODE>
- * SOAPEnvelope.getBody</CODE>. The following lines of code use
- * these two methods after starting with the <CODE>
- * SOAPMessage</CODE> object <I>message</I> to get the <CODE>
- * SOAPPart</CODE> object <I>sp</I>, which is then used to get the
- * <CODE>SOAPEnvelope</CODE> object <I>se</I>.</P>
+ * <P>A client can access the {@code SOAPHeader} and {@code
+ * SOAPBody} objects by calling the methods {@code
+ * SOAPEnvelope.getHeader} and {@code
+ * SOAPEnvelope.getBody}. The following lines of code use
+ * these two methods after starting with the {@code
+ * SOAPMessage} object <I>message</I> to get the {@code
+ * SOAPPart} object <I>sp</I>, which is then used to get the
+ * {@code SOAPEnvelope} object <I>se</I>.</P>
* <PRE>
* SOAPPart sp = message.getSOAPPart();
* SOAPEnvelope se = sp.getEnvelope();
@@ -43,23 +43,23 @@ package org.apache.xmlbeans.impl.soap;
* SOAPBody sb = se.getBody();
* </PRE>
*
- * <P>It is possible to change the body or header of a <CODE>
- * SOAPEnvelope</CODE> object by retrieving the current one,
- * deleting it, and then adding a new body or header. The <CODE>
- * javax.xml.soap.Node</CODE> method <CODE>detachNode</CODE>
+ * <P>It is possible to change the body or header of a {@code
+ * SOAPEnvelope} object by retrieving the current one,
+ * deleting it, and then adding a new body or header. The {@code
+ * javax.xml.soap.Node} method {@code detachNode}
* detaches the XML element (node) on which it is called. For
- * example, the following line of code deletes the <CODE>
- * SOAPBody</CODE> object that is retrieved by the method <CODE>
- * getBody</CODE>.</P>
+ * example, the following line of code deletes the {@code
+ * SOAPBody} object that is retrieved by the method {@code
+ * getBody}.</P>
* <PRE>
* se.getBody().detachNode();
* </PRE>
- * To create a <CODE>SOAPHeader</CODE> object to replace the one
- * that was removed, a client uses the method <CODE>
- * SOAPEnvelope.addHeader</CODE>, which creates a new header and
- * adds it to the <CODE>SOAPEnvelope</CODE> object. Similarly, the
- * method <CODE>addBody</CODE> creates a new <CODE>SOAPBody</CODE>
- * object and adds it to the <CODE>SOAPEnvelope</CODE> object. The
+ * To create a {@code SOAPHeader} object to replace the one
+ * that was removed, a client uses the method {@code
+ * SOAPEnvelope.addHeader}, which creates a new header and
+ * adds it to the {@code SOAPEnvelope} object. Similarly, the
+ * method {@code addBody} creates a new {@code SOAPBody}
+ * object and adds it to the {@code SOAPEnvelope} object. The
* following code fragment retrieves the current header, removes
* it, and adds a new one. Then it retrieves the current body,
* removes it, and adds a new one.
@@ -71,18 +71,18 @@ package org.apache.xmlbeans.impl.soap;
* se.getBody().detachNode();
* SOAPBody sb = se.addBody();
* </PRE>
- * It is an error to add a <CODE>SOAPBody</CODE> or <CODE>
- * SOAPHeader</CODE> object if one already exists.
+ * It is an error to add a {@code SOAPBody} or {@code
+ * SOAPHeader} object if one already exists.
*
- * <P>The <CODE>SOAPEnvelope</CODE> interface provides three
- * methods for creating <CODE>Name</CODE> objects. One method
- * creates <CODE>Name</CODE> objects with a local name, a
+ * <P>The {@code SOAPEnvelope} interface provides three
+ * methods for creating {@code Name} objects. One method
+ * creates {@code Name} objects with a local name, a
* namespace prefix, and a namesapce URI. The second method
- * creates <CODE>Name</CODE> objects with a local name and a
- * namespace prefix, and the third creates <CODE>Name</CODE>
+ * creates {@code Name} objects with a local name and a
+ * namespace prefix, and the third creates {@code Name}
* objects with just a local name. The following line of code, in
- * which <I>se</I> is a <CODE>SOAPEnvelope</CODE> object, creates
- * a new <CODE>Name</CODE> object with all three.</P>
+ * which <I>se</I> is a {@code SOAPEnvelope} object, creates
+ * a new {@code Name} object with all three.</P>
* <PRE>
* Name name = se.createName("GetLastTradePrice", "WOMBAT",
* "http://www.wombat.org/trader");
@@ -91,101 +91,101 @@ package org.apache.xmlbeans.impl.soap;
public interface SOAPEnvelope extends SOAPElement {
/**
- * Creates a new <CODE>Name</CODE> object initialized with the
+ * Creates a new {@code Name} object initialized with the
* given local name, namespace prefix, and namespace URI.
*
- * <P>This factory method creates <CODE>Name</CODE> objects
+ * <P>This factory method creates {@code Name} objects
* for use in the SOAP/XML document.
- * @param localName a <CODE>String</CODE> giving
+ * @param localName a {@code String} giving
* the local name
- * @param prefix a <CODE>String</CODE> giving
+ * @param prefix a {@code String} giving
* the prefix of the namespace
- * @param uri a <CODE>String</CODE> giving the
+ * @param uri a {@code String} giving the
* URI of the namespace
- * @return a <CODE>Name</CODE> object initialized with the given
+ * @return a {@code Name} 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 localName, String prefix, String uri)
+ Name createName(String localName, String prefix, String uri)
throws SOAPException;
/**
- * Creates a new <CODE>Name</CODE> object initialized with the
+ * Creates a new {@code Name} object initialized with the
* given local name.
*
- * <P>This factory method creates <CODE>Name</CODE> objects
+ * <P>This factory method creates {@code Name} objects
* for use in the SOAP/XML document.
*
- * @param localName a <CODE>String</CODE> giving
+ * @param localName a {@code String} giving
* the local name
- * @return a <CODE>Name</CODE> object initialized with the given
+ * @return a {@code Name} object initialized with the given
* local name
* @throws SOAPException if there is a SOAP error
*/
- public abstract Name createName(String localName) throws SOAPException;
+ Name createName(String localName) throws SOAPException;
/**
- * Returns the <CODE>SOAPHeader</CODE> object for this <CODE>
- * SOAPEnvelope</CODE> object.
+ * Returns the {@code SOAPHeader} object for this {@code
+ * SOAPEnvelope} object.
*
- * <P>A new <CODE>SOAPMessage</CODE> object is by default
- * created with a <CODE>SOAPEnvelope</CODE> object that
- * contains an empty <CODE>SOAPHeader</CODE> object. As a
- * result, the method <CODE>getHeader</CODE> will always
- * return a <CODE>SOAPHeader</CODE> object unless the header
+ * <P>A new {@code SOAPMessage} object is by default
+ * created with a {@code SOAPEnvelope} object that
+ * contains an empty {@code SOAPHeader} object. As a
+ * result, the method {@code getHeader} will always
+ * return a {@code SOAPHeader} object unless the header
* has been removed and a new one has not been added.
- * @return the <CODE>SOAPHeader</CODE> object or <CODE>
- * null</CODE> if there is none
+ * @return the {@code SOAPHeader} object or {@code
+ * null} if there is none
* @throws SOAPException if there is a problem
- * obtaining the <CODE>SOAPHeader</CODE> object
+ * obtaining the {@code SOAPHeader} object
*/
- public abstract SOAPHeader getHeader() throws SOAPException;
+ SOAPHeader getHeader() throws SOAPException;
/**
- * Returns the <CODE>SOAPBody</CODE> object associated with
- * this <CODE>SOAPEnvelope</CODE> object.
+ * Returns the {@code SOAPBody} object associated with
+ * this {@code SOAPEnvelope} object.
*
- * <P>A new <CODE>SOAPMessage</CODE> object is by default
- * created with a <CODE>SOAPEnvelope</CODE> object that
- * contains an empty <CODE>SOAPBody</CODE> object. As a
- * result, the method <CODE>getBody</CODE> will always return
- * a <CODE>SOAPBody</CODE> object unless the body has been
+ * <P>A new {@code SOAPMessage} object is by default
+ * created with a {@code SOAPEnvelope} object that
+ * contains an empty {@code SOAPBody} object. As a
+ * result, the method {@code getBody} will always return
+ * a {@code SOAPBody} object unless the body has been
* removed and a new one has not been added.
- * @return the <CODE>SOAPBody</CODE> object for this <CODE>
- * SOAPEnvelope</CODE> object or <CODE>null</CODE> if there
+ * @return the {@code SOAPBody} object for this {@code
+ * SOAPEnvelope} object or {@code null} if there
* is none
* @throws SOAPException if there is a problem
- * obtaining the <CODE>SOAPBody</CODE> object
+ * obtaining the {@code SOAPBody} object
*/
- public abstract SOAPBody getBody() throws SOAPException;
+ SOAPBody getBody() throws SOAPException;
/**
- * Creates a <CODE>SOAPHeader</CODE> object and sets it as the
- * <CODE>SOAPHeader</CODE> object for this <CODE>
- * SOAPEnvelope</CODE> object.
+ * Creates a {@code SOAPHeader} object and sets it as the
+ * {@code SOAPHeader} object for this {@code
+ * SOAPEnvelope} object.
*
* <P>It is illegal to add a header when the envelope already
* contains a header. Therefore, this method should be called
* only after the existing header has been removed.
- * @return the new <CODE>SOAPHeader</CODE> object
- * @throws SOAPException if this <CODE>
- * SOAPEnvelope</CODE> object already contains a valid
- * <CODE>SOAPHeader</CODE> object
+ * @return the new {@code SOAPHeader} object
+ * @throws SOAPException if this {@code
+ * SOAPEnvelope} object already contains a valid
+ * {@code SOAPHeader} object
*/
- public abstract SOAPHeader addHeader() throws SOAPException;
+ SOAPHeader addHeader() throws SOAPException;
/**
- * Creates a <CODE>SOAPBody</CODE> object and sets it as the
- * <CODE>SOAPBody</CODE> object for this <CODE>
- * SOAPEnvelope</CODE> object.
+ * Creates a {@code SOAPBody} object and sets it as the
+ * {@code SOAPBody} object for this {@code
+ * SOAPEnvelope} object.
*
* <P>It is illegal to add a body when the envelope already
* contains a body. Therefore, this method should be called
* only after the existing body has been removed.
- * @return the new <CODE>SOAPBody</CODE> object
- * @throws SOAPException if this <CODE>
- * SOAPEnvelope</CODE> object already contains a valid
- * <CODE>SOAPBody</CODE> object
+ * @return the new {@code SOAPBody} object
+ * @throws SOAPException if this {@code
+ * SOAPEnvelope} object already contains a valid
+ * {@code SOAPBody} object
*/
- public abstract SOAPBody addBody() throws SOAPException;
+ SOAPBody addBody() throws SOAPException;
}
Modified: xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/SOAPException.java
URL: http://svn.apache.org/viewvc/xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/SOAPException.java?rev=1896561&r1=1896560&r2=1896561&view=diff
==============================================================================
--- xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/SOAPException.java (original)
+++ xmlbeans/trunk/src/main/java/org/apache/xmlbeans/impl/soap/SOAPException.java Fri Dec 31 00:01:16 2021
@@ -17,33 +17,33 @@ package org.apache.xmlbeans.impl.soap;
/**
* An exception that signals that a SOAP exception has
- * occurred. A <CODE>SOAPException</CODE> object may contain a
- * <CODE>String</CODE> that gives the reason for the exception, an
- * embedded <CODE>Throwable</CODE> object, or both. This class
+ * occurred. A {@code SOAPException} object may contain a
+ * {@code String} that gives the reason for the exception, an
+ * embedded {@code Throwable} object, or both. This class
* provides methods for retrieving reason messages and for
- * retrieving the embedded <CODE>Throwable</CODE> object.</P>
+ * retrieving the embedded {@code Throwable} object.
*
- * <P>Typical reasons for throwing a <CODE>SOAPException</CODE>
+ * <P>Typical reasons for throwing a {@code SOAPException}
* object are problems such as difficulty setting a header, not
* being able to send a message, and not being able to get a
- * connection with the provider. Reasons for embedding a <CODE>
- * Throwable</CODE> object include problems such as input/output
+ * connection with the provider. Reasons for embedding a {@code
+ * Throwable} object include problems such as input/output
* errors or a parsing problem, such as an error in parsing a
* header.
*/
public class SOAPException extends Exception {
/**
- * Constructs a <CODE>SOAPException</CODE> object with no
- * reason or embedded <CODE>Throwable</CODE> object.
+ * Constructs a {@code SOAPException} object with no
+ * reason or embedded {@code Throwable} object.
*/
public SOAPException() {
cause = null;
}
/**
- * Constructs a <CODE>SOAPException</CODE> object with the
- * given <CODE>String</CODE> as the reason for the exception
+ * Constructs a {@code SOAPException} object with the
+ * given {@code String} as the reason for the exception
* being thrown.
* @param reason a description of what caused
* the exception
@@ -56,14 +56,14 @@ public class SOAPException extends Excep
}
/**
- * Constructs a <CODE>SOAPException</CODE> object with the
- * given <CODE>String</CODE> as the reason for the exception
- * being thrown and the given <CODE>Throwable</CODE> object as
+ * Constructs a {@code SOAPException} object with the
+ * given {@code String} as the reason for the exception
+ * being thrown and the given {@code Throwable} object as
* an embedded exception.
* @param reason a description of what caused
* the exception
- * @param cause a <CODE>Throwable</CODE> object
- * that is to be embedded in this <CODE>SOAPException</CODE>
+ * @param cause a {@code Throwable} object
+ * that is to be embedded in this {@code SOAPException}
* object
*/
public SOAPException(String reason, Throwable cause) {
@@ -74,11 +74,11 @@ public class SOAPException extends Excep
}
/**
- * Constructs a <CODE>SOAPException</CODE> object
- * initialized with the given <CODE>Throwable</CODE>
+ * Constructs a {@code SOAPException} object
+ * initialized with the given {@code Throwable}
* object.
- * @param cause a <CODE>Throwable</CODE> object
- * that is to be embedded in this <CODE>SOAPException</CODE>
+ * @param cause a {@code Throwable} object
+ * that is to be embedded in this {@code SOAPException}
* object
*/
public SOAPException(Throwable cause) {
@@ -89,17 +89,17 @@ public class SOAPException extends Excep
}
/**
- * Returns the detail message for this <CODE>
- * SOAPException</CODE> object.
+ * Returns the detail message for this {@code
+ * SOAPException} object.
*
- * <P>If there is an embedded <CODE>Throwable</CODE> object,
- * and if the <CODE>SOAPException</CODE> object has no detail
+ * <P>If there is an embedded {@code Throwable} object,
+ * and if the {@code SOAPException} object has no detail
* message of its own, this method will return the detail
- * message from the embedded <CODE>Throwable</CODE>
+ * message from the embedded {@code Throwable}
* object.</P>
- * @return the error or warning message for this <CODE>
- * SOAPException</CODE> or, if it has none, the message of
- * the embedded <CODE>Throwable</CODE> object, if there is
+ * @return the error or warning message for this {@code
+ * SOAPException} or, if it has none, the message of
+ * the embedded {@code Throwable} object, if there is
* one
*/
public String getMessage() {
@@ -114,49 +114,47 @@ public class SOAPException extends Excep
}
/**
- * Returns the <CODE>Throwable</CODE> object embedded in
- * this <CODE>SOAPException</CODE> if there is one. Otherwise,
- * this method returns <CODE>null</CODE>.
- * @return the embedded <CODE>Throwable</CODE> object or <CODE>
- * null</CODE> if there is none
+ * Returns the {@code Throwable} object embedded in
+ * this {@code SOAPException} if there is one. Otherwise,
+ * this method returns {@code null}.
+ * @return the embedded {@code Throwable} object or {@code
+ * null} if there is none
*/
public Throwable getCause() {
return cause;
}
/**
- * Initializes the <CODE>cause</CODE> field of this <CODE>
- * SOAPException</CODE> object with the given <CODE>
- * Throwable</CODE> object.
+ * Initializes the {@code cause} field of this {@code
+ * SOAPException} object with the given {@code
+ * Throwable} object.
*
* <P>This method can be called at most once. It is generally
* called from within the constructor or immediately after the
- * constructor has returned a new <CODE>SOAPException</CODE>
- * object. If this <CODE>SOAPException</CODE> object was
+ * constructor has returned a new {@code SOAPException}
+ * object. If this {@code SOAPException} object was
* created with the constructor {@link #SOAPException(java.lang.Throwable) SOAPException(java.lang.Throwable)}
* or {@link #SOAPException(java.lang.String, java.lang.Throwable) SOAPException(java.lang.String, java.lang.Throwable)}, meaning
- * that its <CODE>cause</CODE> field already has a value, this
+ * that its {@code cause} field already has a value, this
* method cannot be called even once.
*
- * @param cause the <CODE>Throwable</CODE>
- * object that caused this <CODE>SOAPException</CODE> object
+ * @param cause the {@code Throwable}
+ * object that caused this {@code SOAPException} object
* to be thrown. The value of this parameter is saved for
- * later retrieval by the <A href=
- * "../../../javax/xml/soap/SOAPException.html#getCause()">
- * <CODE>getCause()</CODE></A> method. A <TT>null</TT> value
- * is permitted and indicates that the cause is nonexistent
- * or unknown.
- * @return a reference to this <CODE>SOAPException</CODE>
+ * later retrieval by the {@link SOAPException#getCause()} method.
+ * A {@code null} value is permitted and indicates that the cause
+ * is nonexistent or unknown.
+ * @return a reference to this {@code SOAPException}
* instance
* @throws java.lang.IllegalArgumentException if
- * <CODE>cause</CODE> is this <CODE>Throwable</CODE> object.
- * (A <CODE>Throwable</CODE> object cannot be its own
+ * {@code cause} is this {@code Throwable} object.
+ * (A {@code Throwable} object cannot be its own
* cause.)
- * @throws java.lang.IllegalStateException if this <CODE>
- * SOAPException</CODE> object was created with {@link #SOAPException(java.lang.Throwable) SOAPException(java.lang.Throwable)}
+ * @throws java.lang.IllegalStateException if this {@code
+ * SOAPException} object was created with {@link #SOAPException(java.lang.Throwable) SOAPException(java.lang.Throwable)}
* or {@link #SOAPException(java.lang.String, java.lang.Throwable) SOAPException(java.lang.String, java.lang.Throwable)}, or this
- * method has already been called on this <CODE>
- * SOAPException</CODE> object
+ * method has already been called on this {@code
+ * SOAPException} object
*/
public synchronized Throwable initCause(Throwable cause) {
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org