--- old/src/java.xml.ws/share/classes/javax/xml/soap/SOAPElement.java 2015-04-21 17:20:15.840098476 +0400
+++ new/src/java.xml.ws/share/classes/javax/xml/soap/SOAPElement.java 2015-04-21 17:20:15.748098476 +0400
@@ -38,7 +38,7 @@
* Methods in this interface that are required to return SAAJ specific objects
* may "silently" replace nodes in the tree as required to successfully return
* objects of the correct type. See {@link #getChildElements()} and
- * {@link javax.xml.soap}
+ * {@link javax.xml.soap}
* for details.
*
* @since 1.6
@@ -46,115 +46,115 @@
public interface SOAPElement extends Node, org.w3c.dom.Element {
/**
- * Creates a new SOAPElement
object initialized with the
- * given Name
object and adds the new element to this
- * SOAPElement
object.
+ * Creates a new {@code SOAPElement} object initialized with the
+ * given {@code Name} object and adds the new element to this
+ * {@code SOAPElement} object.
*
* This method may be deprecated in a future release of SAAJ in favor of
* addChildElement(javax.xml.namespace.QName)
*
- * @param name a Name
object with the XML name for the
+ * @param name a {@code Name} object with the XML name for the
* new element
*
- * @return the new SOAPElement
object that was created
+ * @return the new {@code SOAPElement} object that was created
* @exception SOAPException if there is an error in creating the
- * SOAPElement
object
+ * {@code SOAPElement} object
* @see SOAPElement#addChildElement(javax.xml.namespace.QName)
*/
public SOAPElement addChildElement(Name name) throws SOAPException;
/**
- * Creates a new SOAPElement
object initialized with the given
- * QName
object and adds the new element to this SOAPElement
+ * Creates a new {@code SOAPElement} object initialized with the given
+ * {@code QName} object and adds the new element to this {@code SOAPElement}
* object. The namespace, localname and prefix of the new
- * SOAPElement
are all taken from the qname
argument.
+ * {@code SOAPElement} are all taken from the {@code qname} argument.
*
- * @param qname a QName
object with the XML name for the
+ * @param qname a {@code QName} object with the XML name for the
* new element
*
- * @return the new SOAPElement
object that was created
+ * @return the new {@code SOAPElement} object that was created
* @exception SOAPException if there is an error in creating the
- * SOAPElement
object
+ * {@code SOAPElement} object
* @see SOAPElement#addChildElement(Name)
* @since 1.6, SAAJ 1.3
*/
public SOAPElement addChildElement(QName qname) throws SOAPException;
/**
- * Creates a new SOAPElement
object initialized with the
+ * Creates a new {@code SOAPElement} object initialized with the
* specified local name and adds the new element to this
- * SOAPElement
object.
- * The new SOAPElement
inherits any in-scope default namespace.
+ * {@code SOAPElement} object.
+ * The new {@code SOAPElement} inherits any in-scope default namespace.
*
- * @param localName a String
giving the local name for
+ * @param localName a {@code String} giving the local name for
* the element
- * @return the new SOAPElement
object that was created
+ * @return the new {@code SOAPElement} object that was created
* @exception SOAPException if there is an error in creating the
- * SOAPElement
object
+ * {@code SOAPElement} object
*/
public SOAPElement addChildElement(String localName) throws SOAPException;
/**
- * Creates a new SOAPElement
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
- * SOAPElement
object.
+ * {@code SOAPElement} object.
*
- * @param localName a String
giving the local name for
+ * @param localName a {@code String} giving the local name for
* the new element
- * @param prefix a String
giving the namespace prefix for
+ * @param prefix a {@code String} giving the namespace prefix for
* the new element
*
- * @return the new SOAPElement
object that was created
- * @exception SOAPException if the prefix
is not valid in the
- * context of this SOAPElement
or if there is an error in creating the
- * SOAPElement
object
+ * @return the new {@code SOAPElement} object that was created
+ * @exception SOAPException if the {@code prefix} is not valid in the
+ * context of this {@code SOAPElement} or if there is an error in creating the
+ * {@code SOAPElement} object
*/
public SOAPElement addChildElement(String localName, String prefix)
throws SOAPException;
/**
- * Creates a new SOAPElement
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
- * SOAPElement
object.
+ * {@code SOAPElement} object.
*
- * @param localName a String
giving the local name for
+ * @param localName a {@code String} giving the local name for
* the new element
- * @param prefix a String
giving the namespace prefix for
+ * @param prefix a {@code String} giving the namespace prefix for
* the new element
- * @param uri a String
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 SOAPElement
object that was created
+ * @return the new {@code SOAPElement} object that was created
* @exception SOAPException if there is an error in creating the
- * SOAPElement
object
+ * {@code SOAPElement} object
*/
public SOAPElement addChildElement(String localName, String prefix,
String uri)
throws SOAPException;
/**
- * Add a SOAPElement
as a child of this
- * SOAPElement
instance. The SOAPElement
+ * Add a {@code SOAPElement} as a child of this
+ * {@code SOAPElement} instance. The {@code SOAPElement}
* is expected to be created by a
- * SOAPFactory
. Callers should not rely on the
+ * {@code SOAPFactory}. 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 SOAPElement
passed into an instance of
- * a different SOAPElement
implementation. For
- * instance if addChildElement()
is called on a
- * SOAPHeader
, element
will be copied
- * into an instance of a SOAPHeaderElement
.
+ * 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}.
*
- *
The fragment rooted in element
is either added
+ *
The fragment rooted in {@code element} is either added * as a whole or not at all, if there was an error. * - *
The fragment rooted in element
cannot contain
+ *
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 SOAPElement
to be added as a
+ * @param element the {@code SOAPElement} to be added as a
* new child
*
* @exception SOAPException if there was an error in adding this
@@ -167,10 +167,10 @@
throws SOAPException;
/**
- * Detaches all children of this SOAPElement
.
+ * Detaches all children of this {@code SOAPElement}.
*
* This method is useful for rolling back the construction of partially
- * completed SOAPHeaders
and SOAPBodys
in
+ * completed {@code SOAPHeaders} and {@code SOAPBodys} in
* preparation for sending a fault when an error condition is detected. It
* is also useful for recycling portions of a document within a SOAP
* message.
@@ -180,33 +180,33 @@
public abstract void removeContents();
/**
- * Creates a new Text
object initialized with the given
- * String
and adds it to this SOAPElement
object.
+ * Creates a new {@code Text} object initialized with the given
+ * {@code String} and adds it to this {@code SOAPElement} object.
*
- * @param text a String
object with the textual content to be added
+ * @param text a {@code String} object with the textual content to be added
*
- * @return the SOAPElement
object into which
- * the new Text
object was inserted
+ * @return the {@code SOAPElement} object into which
+ * the new {@code Text} object was inserted
* @exception SOAPException if there is an error in creating the
- * new Text
object or if it is not legal to
+ * new {@code Text} object or if it is not legal to
* attach it as a child to this
- * SOAPElement
+ * {@code SOAPElement}
*/
public SOAPElement addTextNode(String text) throws SOAPException;
/**
* Adds an attribute with the specified name and value to this
- * SOAPElement
object.
+ * {@code SOAPElement} object.
*
- * @param name a Name
object with the name of the attribute
- * @param value a String
giving the value of the attribute
- * @return the SOAPElement
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
*
* @exception SOAPException if there is an error in creating the
* Attribute, or it is invalid to set
- an attribute with Name
- name
on this SOAPElement.
+ an attribute with {@code Name}
+ {@code name} on this SOAPElement.
* @see SOAPElement#addAttribute(javax.xml.namespace.QName, String)
*/
public SOAPElement addAttribute(Name name, String value)
@@ -214,17 +214,17 @@
/**
* Adds an attribute with the specified name and value to this
- * SOAPElement
object.
+ * {@code SOAPElement} object.
*
- * @param qname a QName
object with the name of the attribute
- * @param value a String
giving the value of the attribute
- * @return the SOAPElement
object into which the attribute was
+ * @param qname a {@code QName} 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
*
* @exception SOAPException if there is an error in creating the
* Attribute, or it is invalid to set
- an attribute with QName
- qname
on this SOAPElement.
+ an attribute with {@code QName}
+ {@code qname} on this SOAPElement.
* @see SOAPElement#addAttribute(Name, String)
* @since 1.6, SAAJ 1.3
*/
@@ -233,11 +233,11 @@
/**
* Adds a namespace declaration with the specified prefix and URI to this
- * SOAPElement
object.
+ * {@code SOAPElement} object.
*
- * @param prefix a String
giving the prefix of the namespace
- * @param uri a String
giving the uri of the namespace
- * @return the SOAPElement
object into which this
+ * @param prefix a {@code String} giving the prefix of the namespace
+ * @param uri a {@code String} giving the uri of the namespace
+ * @return the {@code SOAPElement} object into which this
* namespace declaration was inserted.
*
* @exception SOAPException if there is an error in creating the
@@ -249,8 +249,8 @@
/**
* Returns the value of the attribute with the specified name.
*
- * @param name a Name
object with the name of the attribute
- * @return a String
giving the value of the specified
+ * @param name a {@code Name} object with the name of the attribute
+ * @return a {@code String} giving the value of the specified
* attribute, Null if there is no such attribute
* @see SOAPElement#getAttributeValue(javax.xml.namespace.QName)
*/
@@ -259,8 +259,8 @@
/**
* Returns the value of the attribute with the specified qname.
*
- * @param qname a QName
object with the qname of the attribute
- * @return a String
giving the value of the specified
+ * @param qname a {@code QName} object with the qname of the attribute
+ * @return a {@code String} giving the value of the specified
* attribute, Null if there is no such attribute
* @see SOAPElement#getAttributeValue(Name)
* @since 1.6, SAAJ 1.3
@@ -268,11 +268,11 @@
public String getAttributeValue(QName qname);
/**
- * Returns an Iterator
over all of the attribute
- * Name
objects in this
- * SOAPElement
object. The iterator can be used to get
+ * Returns an {@code Iterator} over all of the attribute
+ * {@code Name} objects in this
+ * {@code SOAPElement} object. The iterator can be used to get
* the attribute names, which can then be passed to the method
- * getAttributeValue
to retrieve the value of each
+ * {@code getAttributeValue} to retrieve the value of each
* attribute.
*
* @see SOAPElement#getAllAttributesAsQNames()
@@ -281,10 +281,10 @@
public Iterator getAllAttributes();
/**
- * Returns an Iterator
over all of the attributes
- * in this SOAPElement
as QName
objects.
+ * Returns an {@code Iterator} over all of the attributes
+ * in this {@code SOAPElement} as {@code QName} objects.
* The iterator can be used to get the attribute QName, which can then
- * be passed to the method getAttributeValue
to retrieve
+ * be passed to the method {@code getAttributeValue} to retrieve
* the value of each attribute.
*
* @return an iterator over the QNames of the attributes
@@ -297,94 +297,94 @@
/**
* Returns the URI of the namespace that has the given prefix.
*
- * @param prefix a String
giving the prefix of the namespace
+ * @param prefix a {@code String} giving the prefix of the namespace
* for which to search
- * @return a String
with the uri of the namespace that has
+ * @return a {@code String} with the uri of the namespace that has
* the given prefix
*/
public String getNamespaceURI(String prefix);
/**
- * Returns an Iterator
over the namespace prefix
- * String
s declared by this element. The prefixes returned by
+ * Returns an {@code Iterator} over the namespace prefix
+ * {@code String}s declared by this element. The prefixes returned by
* this iterator can be passed to the method
- * getNamespaceURI
to retrieve the URI of each namespace.
+ * {@code getNamespaceURI} to retrieve the URI of each namespace.
*
* @return an iterator over the namespace prefixes in this
- * SOAPElement
object
+ * {@code SOAPElement} object
*/
public Iterator getNamespacePrefixes();
/**
- * Returns an Iterator
over the namespace prefix
- * String
s visible to this element. The prefixes returned by
+ * 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
- * getNamespaceURI
to retrieve the URI of each namespace.
+ * {@code getNamespaceURI} to retrieve the URI of each namespace.
*
* @return an iterator over the namespace prefixes are within scope of this
- * SOAPElement
object
+ * {@code SOAPElement} object
*
* @since 1.6, SAAJ 1.2
*/
public Iterator getVisibleNamespacePrefixes();
/**
- * Creates a QName
whose namespace URI is the one associated
- * with the parameter, prefix
, in the context of this
- * SOAPElement
. The remaining elements of the new
- * QName
are taken directly from the parameters,
- * localName
and prefix
.
+ * Creates a {@code QName} whose namespace URI is the one associated
+ * with the parameter, {@code prefix}, in the context of this
+ * {@code SOAPElement}. The remaining elements of the new
+ * {@code QName} are taken directly from the parameters,
+ * {@code localName} and {@code prefix}.
*
* @param localName
- * a String
containing the local part of the name.
+ * a {@code String} containing the local part of the name.
* @param prefix
- * a String
containing the prefix for the name.
+ * a {@code String} containing the prefix for the name.
*
- * @return a QName
with the specified localName
- * and prefix
, and with a namespace that is associated
- * with the prefix
in the context of this
- * SOAPElement
. This namespace will be the same as
+ * @return a {@code QName} with the specified {@code localName}
+ * and {@code prefix}, and with a namespace that is associated
+ * with the {@code prefix} in the context of this
+ * {@code SOAPElement}. This namespace will be the same as
* the one that would be returned by
* {@link #getNamespaceURI(String)}
if it were given
- * prefix
as it's parameter.
+ * {@code prefix} as it's parameter.
*
- * @exception SOAPException if the QName
cannot be created.
+ * @exception SOAPException if the {@code QName} cannot be created.
*
* @since 1.6, SAAJ 1.3
*/
public QName createQName(String localName, String prefix)
throws SOAPException;
/**
- * Returns the name of this SOAPElement
object.
+ * Returns the name of this {@code SOAPElement} object.
*
- * @return a Name
object with the name of this
- * SOAPElement
object
+ * @return a {@code Name} object with the name of this
+ * {@code SOAPElement} object
*/
public Name getElementName();
/**
- * Returns the qname of this SOAPElement
object.
+ * Returns the qname of this {@code SOAPElement} object.
*
- * @return a QName
object with the qname of this
- * SOAPElement
object
+ * @return a {@code QName} object with the qname of this
+ * {@code SOAPElement} object
* @see SOAPElement#getElementName()
* @since 1.6, SAAJ 1.3
*/
public QName getElementQName();
/**
- * Changes the name of this Element
to newName
if
+ * Changes the name of this {@code Element} to {@code newName} if
* possible. SOAP Defined elements such as SOAPEnvelope, SOAPHeader, SOAPBody
* etc. cannot have their names changed using this method. Any attempt to do
* so will result in a SOAPException being thrown.
*
* Callers should not rely on the element instance being renamed as is.
* Implementations could end up copying the content of the
- * SOAPElement
to a renamed instance.
+ * {@code SOAPElement} to a renamed instance.
*
- * @param newName the new name for the Element
.
+ * @param newName the new name for the {@code Element}.
*
- * @exception SOAPException if changing the name of this Element
+ * @exception SOAPException if changing the name of this {@code Element}
* is not allowed.
* @return The renamed Node
*
@@ -395,10 +395,10 @@
/**
* Removes the attribute with the specified name.
*
- * @param name the Name
object with the name of the
+ * @param name the {@code Name} object with the name of the
* attribute to be removed
- * @return true
if the attribute was
- * removed successfully; false
if it was not
+ * @return {@code true} if the attribute was
+ * removed successfully; {@code false} if it was not
* @see SOAPElement#removeAttribute(javax.xml.namespace.QName)
*/
public boolean removeAttribute(Name name);
@@ -406,10 +406,10 @@
/**
* Removes the attribute with the specified qname.
*
- * @param qname the QName
object with the qname of the
+ * @param qname the {@code QName} object with the qname of the
* attribute to be removed
- * @return true
if the attribute was
- * removed successfully; false
if it was not
+ * @return {@code true} if the attribute was
+ * removed successfully; {@code false} if it was not
* @see SOAPElement#removeAttribute(Name)
* @since 1.6, SAAJ 1.3
*/
@@ -418,84 +418,84 @@
/**
* Removes the namespace declaration corresponding to the given prefix.
*
- * @param prefix a String
giving the prefix for which
+ * @param prefix a {@code String} giving the prefix for which
* to search
- * @return true
if the namespace declaration was
- * removed successfully; false
if it was not
+ * @return {@code true} if the namespace declaration was
+ * removed successfully; {@code false} if it was not
*/
public boolean removeNamespaceDeclaration(String prefix);
/**
- * Returns an Iterator
over all the immediate child
- * {@link Node}s of this element. This includes javax.xml.soap.Text
- * objects as well as SOAPElement
objects.
+ * Returns an {@code Iterator} over all the immediate child
+ * {@link Node}s of this element. This includes {@code javax.xml.soap.Text}
+ * objects as well as {@code SOAPElement} objects.
*
- * Calling this method may cause child Element
,
- * SOAPElement
and org.w3c.dom.Text
nodes to be
- * replaced by SOAPElement
, SOAPHeaderElement
,
- * SOAPBodyElement
or javax.xml.soap.Text
nodes as
+ * Calling this method may cause child {@code Element},
+ * {@code SOAPElement} and {@code org.w3c.dom.Text} nodes to be
+ * replaced by {@code SOAPElement}, {@code SOAPHeaderElement},
+ * {@code SOAPBodyElement} or {@code javax.xml.soap.Text} nodes as
* appropriate for the type of this parent node. As a result the calling
* application must treat any existing references to these child nodes that
* have been obtained through DOM APIs as invalid and either discard them or
- * refresh them with the values returned by this Iterator
. This
+ * refresh them with the values returned by this {@code Iterator}. This
* behavior can be avoided by calling the equivalent DOM APIs. See
- * {@link javax.xml.soap}
+ * {@link javax.xml.soap}
* for more details.
*
- * @return an iterator with the content of this SOAPElement
+ * @return an iterator with the content of this {@code SOAPElement}
* object
*/
public Iterator getChildElements();
/**
- * Returns an Iterator
over all the immediate child
+ * Returns an {@code Iterator} over all the immediate child
* {@link Node}s of this element with the specified name. All of these
- * children will be SOAPElement
nodes.
+ * children will be {@code SOAPElement} nodes.
*
- * Calling this method may cause child Element
,
- * SOAPElement
and org.w3c.dom.Text
nodes to be
- * replaced by SOAPElement
, SOAPHeaderElement
,
- * SOAPBodyElement
or javax.xml.soap.Text
nodes as
+ * Calling this method may cause child {@code Element},
+ * {@code SOAPElement} and {@code org.w3c.dom.Text} nodes to be
+ * replaced by {@code SOAPElement}, {@code SOAPHeaderElement},
+ * {@code SOAPBodyElement} or {@code javax.xml.soap.Text} nodes as
* appropriate for the type of this parent node. As a result the calling
* application must treat any existing references to these child nodes that
* have been obtained through DOM APIs as invalid and either discard them or
- * refresh them with the values returned by this Iterator
. This
+ * refresh them with the values returned by this {@code Iterator}. This
* behavior can be avoided by calling the equivalent DOM APIs. See
- * {@link javax.xml.soap}
+ * {@link javax.xml.soap}
* for more details.
*
- * @param name a Name
object with the name of the child
+ * @param name a {@code Name} object with the name of the child
* elements to be returned
*
- * @return an Iterator
object over all the elements
- * in this SOAPElement
object with the
+ * @return an {@code Iterator} object over all the elements
+ * in this {@code SOAPElement} object with the
* specified name
* @see SOAPElement#getChildElements(javax.xml.namespace.QName)
*/
public Iterator getChildElements(Name name);
/**
- * Returns an Iterator
over all the immediate child
+ * Returns an {@code Iterator} over all the immediate child
* {@link Node}s of this element with the specified qname. All of these
- * children will be SOAPElement
nodes.
+ * children will be {@code SOAPElement} nodes.
*
- * Calling this method may cause child Element
,
- * SOAPElement
and org.w3c.dom.Text
nodes to be
- * replaced by SOAPElement
, SOAPHeaderElement
,
- * SOAPBodyElement
or javax.xml.soap.Text
nodes as
+ * Calling this method may cause child {@code Element},
+ * {@code SOAPElement} and {@code org.w3c.dom.Text} nodes to be
+ * replaced by {@code SOAPElement}, {@code SOAPHeaderElement},
+ * {@code SOAPBodyElement} or {@code javax.xml.soap.Text} nodes as
* appropriate for the type of this parent node. As a result the calling
* application must treat any existing references to these child nodes that
* have been obtained through DOM APIs as invalid and either discard them or
- * refresh them with the values returned by this Iterator
. This
+ * refresh them with the values returned by this {@code Iterator}. This
* behavior can be avoided by calling the equivalent DOM APIs. See
- * {@link javax.xml.soap}
+ * {@link javax.xml.soap}
* for more details.
*
- * @param qname a QName
object with the qname of the child
+ * @param qname a {@code QName} object with the qname of the child
* elements to be returned
*
- * @return an Iterator
object over all the elements
- * in this SOAPElement
object with the
+ * @return an {@code Iterator} object over all the elements
+ * in this {@code SOAPElement} object with the
* specified qname
* @see SOAPElement#getChildElements(Name)
* @since 1.6, SAAJ 1.3
@@ -503,10 +503,10 @@
public Iterator getChildElements(QName qname);
/**
- * Sets the encoding style for this SOAPElement
object
+ * Sets the encoding style for this {@code SOAPElement} object
* to one specified.
*
- * @param encodingStyle a String
giving the encoding style
+ * @param encodingStyle a {@code String} giving the encoding style
*
* @exception IllegalArgumentException if there was a problem in the
* encoding style being set.
@@ -516,9 +516,9 @@
public void setEncodingStyle(String encodingStyle)
throws SOAPException;
/**
- * Returns the encoding style for this SOAPElement
object.
+ * Returns the encoding style for this {@code SOAPElement} object.
*
- * @return a String
giving the encoding style
+ * @return a {@code String} giving the encoding style
*
* @see #setEncodingStyle
*/