--- old/src/java.xml.ws/share/classes/javax/xml/soap/SOAPEnvelope.java 2015-07-09 12:13:58.000000000 +0200
+++ new/src/java.xml.ws/share/classes/javax/xml/soap/SOAPEnvelope.java 2015-07-09 12:13:58.000000000 +0200
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2004, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -28,87 +28,87 @@
/**
* The container for the SOAPHeader and SOAPBody portions of a
- * SOAPPart
object. By default, a SOAPMessage
- * object is created with a SOAPPart
object that has a
- * SOAPEnvelope
object. The SOAPEnvelope
object
- * by default has an empty SOAPBody
object and an empty
- * SOAPHeader
object. The SOAPBody
object is
- * required, and the SOAPHeader
object, though
+ * {@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
- * SOAPHeader
object is not needed, it can be deleted,
+ * {@code SOAPHeader} object is not needed, it can be deleted,
* which is shown later.
*
- * A client can access the SOAPHeader
and SOAPBody
- * objects by calling the methods SOAPEnvelope.getHeader
and
- * SOAPEnvelope.getBody
. The
+ * 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 SOAPMessage
- * object message to get the SOAPPart
object sp,
- * which is then used to get the SOAPEnvelope
object se.
+ * the {@code SOAPMessage}
+ * object message to get the {@code SOAPPart} object sp,
+ * which is then used to get the {@code SOAPEnvelope} object se.
*
- *
+ **{@code * SOAPPart sp = message.getSOAPPart(); * SOAPEnvelope se = sp.getEnvelope(); * SOAPHeader sh = se.getHeader(); * SOAPBody sb = se.getBody(); - *+ * }
- * It is possible to change the body or header of a SOAPEnvelope
+ * 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 javax.xml.soap.Node
method
- * deleteNode
deletes the XML element (node) on which it is
+ * a new body or header. The {@code javax.xml.soap.Node} method
+ * {@code deleteNode} deletes the XML element (node) on which it is
* called. For example, the following line of code deletes the
- * SOAPBody
object that is retrieved by the method getBody
.
- *
+ * {@code SOAPBody} object that is retrieved by the method {@code getBody}. + *+ * To create a {@code SOAPHeader} object to replace the one that was removed, * a client uses - * the method{@code * se.getBody().detachNode(); - *- * To create aSOAPHeader
object to replace the one that was removed, + * }
SOAPEnvelope.addHeader
, which creates a new header and
- * adds it to the SOAPEnvelope
object. Similarly, the method
- * addBody
creates a new SOAPBody
object and adds
- * it to the SOAPEnvelope
object. The following code fragment
+ * 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.
*
- * + *+ * It is an error to add a {@code SOAPBody} or {@code SOAPHeader} * object if one already exists. *{@code * SOAPPart sp = message.getSOAPPart(); * SOAPEnvelope se = sp.getEnvelope(); * se.getHeader().detachNode(); * SOAPHeader sh = se.addHeader(); * se.getBody().detachNode(); * SOAPBody sb = se.addBody(); - *- * It is an error to add aSOAPBody
orSOAPHeader
+ * }
- * The SOAPEnvelope
interface provides three methods for creating
- * Name
objects. One method creates Name
objects with
+ * 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
- * Name
objects with a local name and a namespace prefix, and the third
- * creates Name
objects with just a local name. The following line of
- * code, in which se is a SOAPEnvelope
object, creates a new
- * Name
object with all three.
- *
+ * {@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 se is a {@code SOAPEnvelope} object, creates a new + * {@code Name} object with all three. + ** * @since 1.6 */ public interface SOAPEnvelope extends SOAPElement { /** - * Creates a new{@code * Name name = se.createName("GetLastTradePrice", "WOMBAT", * "http://www.wombat.org/trader"); - *+ * }
Name
object initialized with the
+ * Creates a new {@code Name} object initialized with the
* given local name, namespace prefix, and namespace URI.
*
- * This factory method creates Name
objects for use in
+ * This factory method creates {@code Name} objects for use in
* the SOAP/XML document.
*
- * @param localName a String
giving the local name
- * @param prefix a String
giving the prefix of the namespace
- * @param uri a String
giving the URI of the namespace
- * @return a Name
object initialized with the given
+ * @param localName a {@code String} giving the local name
+ * @param prefix a {@code String} giving the prefix of the namespace
+ * @param uri a {@code String} giving the URI of the namespace
+ * @return a {@code Name} object initialized with the given
* local name, namespace prefix, and namespace URI
* @throws SOAPException if there is a SOAP error
*/
@@ -117,14 +117,14 @@
throws SOAPException;
/**
- * Creates a new Name
object initialized with the
+ * Creates a new {@code Name} object initialized with the
* given local name.
*
- * This factory method creates Name
objects for use in
+ * This factory method creates {@code Name} objects for use in
* the SOAP/XML document.
*
- * @param localName a String
giving the local name
- * @return a Name
object initialized with the given
+ * @param localName a {@code String} giving the local name
+ * @return a {@code Name} object initialized with the given
* local name
* @throws SOAPException if there is a SOAP error
*/
@@ -132,71 +132,71 @@
throws SOAPException;
/**
- * Returns the SOAPHeader
object for
- * this SOAPEnvelope
object.
+ * Returns the {@code SOAPHeader} object for
+ * this {@code SOAPEnvelope} object.
*
- * A new SOAPMessage
object is by default created with a
- * SOAPEnvelope
object that contains an empty
- * SOAPHeader
object. As a result, the method
- * getHeader
will always return a SOAPHeader
+ * 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 SOAPHeader
object or null
if
+ * @return the {@code SOAPHeader} object or {@code null} if
* there is none
* @exception SOAPException if there is a problem obtaining the
- * SOAPHeader
object
+ * {@code SOAPHeader} object
*/
public SOAPHeader getHeader() throws SOAPException;
/**
- * Returns the SOAPBody
object associated with this
- * SOAPEnvelope
object.
+ * Returns the {@code SOAPBody} object associated with this
+ * {@code SOAPEnvelope} object.
*
- * A new SOAPMessage
object is by default created with a
- * SOAPEnvelope
object that contains an empty
- * SOAPBody
object. As a result, the method
- * getBody
will always return a SOAPBody
+ * 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 SOAPBody
object for this
- * SOAPEnvelope
object or null
+ * @return the {@code SOAPBody} object for this
+ * {@code SOAPEnvelope} object or {@code null}
* if there is none
* @exception SOAPException if there is a problem obtaining the
- * SOAPBody
object
+ * {@code SOAPBody} object
*/
public SOAPBody getBody() throws SOAPException;
/**
- * Creates a SOAPHeader
object and sets it as the
- * SOAPHeader
object for this SOAPEnvelope
+ * Creates a {@code SOAPHeader} object and sets it as the
+ * {@code SOAPHeader} object for this {@code SOAPEnvelope}
* object.
*
* 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 SOAPHeader
object
+ * @return the new {@code SOAPHeader} object
*
* @exception SOAPException if this
- * SOAPEnvelope
object already contains a
- * valid SOAPHeader
object
+ * {@code SOAPEnvelope} object already contains a
+ * valid {@code SOAPHeader} object
*/
public SOAPHeader addHeader() throws SOAPException;
/**
- * Creates a SOAPBody
object and sets it as the
- * SOAPBody
object for this SOAPEnvelope
+ * Creates a {@code SOAPBody} object and sets it as the
+ * {@code SOAPBody} object for this {@code SOAPEnvelope}
* object.
*
* 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 SOAPBody
object
+ * @return the new {@code SOAPBody} object
*
* @exception SOAPException if this
- * SOAPEnvelope
object already contains a
- * valid SOAPBody
object
+ * {@code SOAPEnvelope} object already contains a
+ * valid {@code SOAPBody} object
*/
public SOAPBody addBody() throws SOAPException;
}