*
*
DetailEntry objects. DetailEntry
+ * A container for {@code DetailEntry} objects. {@code DetailEntry}
* objects give detailed error information that is application-specific and
- * related to the SOAPBody object that contains it.
+ * related to the {@code SOAPBody} object that contains it.
*
- * A Detail object, which is part of a SOAPFault
- * object, can be retrieved using the method SOAPFault.getDetail.
- * The Detail interface provides two methods. One creates a new
- * DetailEntry object and also automatically adds it to
- * the Detail object. The second method gets a list of the
- * DetailEntry objects contained in a Detail
+ * A {@code Detail} object, which is part of a {@code SOAPFault}
+ * object, can be retrieved using the method {@code SOAPFault.getDetail}.
+ * The {@code Detail} interface provides two methods. One creates a new
+ * {@code DetailEntry} object and also automatically adds it to
+ * the {@code Detail} object. The second method gets a list of the
+ * {@code DetailEntry} objects contained in a {@code Detail}
* object.
*
- * The following code fragment, in which sf is a SOAPFault
- * object, gets its Detail object (d), adds a new
- * DetailEntry object to d, and then gets a list of all the
- * DetailEntry objects in d. The code also creates a
- * Name object to pass to the method addDetailEntry.
- * The variable se, used to create the Name object,
- * is a SOAPEnvelope object.
- *
+ * The following code fragment, in which sf is a {@code SOAPFault}
+ * object, gets its {@code Detail} object (d), adds a new
+ * {@code DetailEntry} object to d, and then gets a list of all the
+ * {@code DetailEntry} objects in d. The code also creates a
+ * {@code Name} object to pass to the method {@code addDetailEntry}.
+ * The variable se, used to create the {@code Name} object,
+ * is a {@code SOAPEnvelope} object.
+ * {@code
* Detail d = sf.getDetail();
* Name name = se.createName("GetLastTradePrice", "WOMBAT",
* "http://www.wombat.org/trader");
* d.addDetailEntry(name);
* Iterator it = d.getDetailEntries();
- *
+ * }
*
* @since 1.6
*/
public interface Detail extends SOAPFaultElement {
/**
- * Creates a new DetailEntry object with the given
- * name and adds it to this Detail object.
+ * Creates a new {@code DetailEntry} object with the given
+ * name and adds it to this {@code Detail} object.
*
- * @param name a Name object identifying the
- * new DetailEntry object
+ * @param name a {@code Name} object identifying the
+ * new {@code DetailEntry} object
*
* @exception SOAPException thrown when there is a problem in adding a
* DetailEntry object to this Detail object.
@@ -76,12 +76,12 @@
public DetailEntry addDetailEntry(Name name) throws SOAPException;
/**
- * Creates a new DetailEntry object with the given
- * QName and adds it to this Detail object. This method
+ * Creates a new {@code DetailEntry} object with the given
+ * QName and adds it to this {@code Detail} object. This method
* is the preferred over the one using Name.
*
- * @param qname a QName object identifying the
- * new DetailEntry object
+ * @param qname a {@code QName} object identifying the
+ * new {@code DetailEntry} object
*
* @exception SOAPException thrown when there is a problem in adding a
* DetailEntry object to this Detail object.
@@ -92,10 +92,10 @@
public DetailEntry addDetailEntry(QName qname) throws SOAPException;
/**
- * Gets an Iterator over all of the DetailEntrys in this Detail object.
+ * Gets an Iterator over all of the {@code DetailEntry}s in this {@code Detail} object.
*
- * @return an Iterator object over the DetailEntry
- * objects in this Detail object
+ * @return an {@code Iterator} object over the {@code DetailEntry}
+ * objects in this {@code Detail} object
*/
public Iterator getDetailEntries();
}
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/soap/DetailEntry.java
--- a/src/java.xml.ws/share/classes/javax/xml/soap/DetailEntry.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/soap/DetailEntry.java Thu Jul 16 19:27:53 2015 -0700
@@ -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
@@ -26,9 +26,9 @@
package javax.xml.soap;
/**
- * The content for a Detail object, giving details for
- * a SOAPFault object. A DetailEntry object,
- * which carries information about errors related to the SOAPBody
+ * The content for a {@code Detail} object, giving details for
+ * a {@code SOAPFault} object. A {@code DetailEntry} object,
+ * which carries information about errors related to the {@code SOAPBody}
* object that contains it, is application-specific.
*
* @since 1.6
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/soap/FactoryFinder.java
--- a/src/java.xml.ws/share/classes/javax/xml/soap/FactoryFinder.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/soap/FactoryFinder.java Thu Jul 16 19:27:53 2015 -0700
@@ -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
@@ -33,7 +33,7 @@
/**
* Creates an instance of the specified class using the specified
- * ClassLoader object.
+ * {@code ClassLoader} object.
*
* @exception SOAPException if the given class could not be found
* or could not be instantiated
@@ -54,13 +54,13 @@
}
/**
- * Finds the implementation Class object for the given
+ * Finds the implementation {@code Class} object for the given
* factory name, or null if that fails.
*
* This method is package private so that this code can be shared.
*
- * @return the Class object of the specified message factory;
- * or null
+ * @return the {@code Class} object of the specified message factory;
+ * or {@code null}
*
* @param factoryId the name of the factory to find, which is
* a system property
@@ -73,22 +73,22 @@
}
/**
- * Finds the implementation Class object for the given
- * factory name, or if that fails, finds the Class object
+ * Finds the implementation {@code Class} object for the given
+ * factory name, or if that fails, finds the {@code Class} object
* for the given fallback class name. The arguments supplied must be
* used in order. If using the first argument is successful, the second
* one will not be used.
*
* This method is package private so that this code can be shared.
*
- * @return the Class object of the specified message factory;
- * may be null
+ * @return the {@code Class} object of the specified message factory;
+ * may be {@code null}
*
* @param factoryId the name of the factory to find, which is
* a system property
* @param fallbackClassName the implementation class name, which is
* to be used only if nothing else
- * is found; null to indicate that
+ * is found; {@code null} to indicate that
* there is no fallback class name
* @exception SOAPException if there is a SOAP error
*/
@@ -99,24 +99,24 @@
}
/**
- * Finds the implementation Class object for the given
- * factory name, or if that fails, finds the Class object
- * for the given default class name, but only if tryFallback
- * is true. The arguments supplied must be used in order
+ * Finds the implementation {@code Class} object for the given
+ * factory name, or if that fails, finds the {@code Class} object
+ * for the given default class name, but only if {@code tryFallback}
+ * is {@code true}. The arguments supplied must be used in order
* If using the first argument is successful, the second one will not
* be used. Note the default class name may be needed even if fallback
* is not to be attempted, so certain error conditions can be handled.
*
* This method is package private so that this code can be shared.
*
- * @return the Class object of the specified message factory;
- * may not be null
+ * @return the {@code Class} object of the specified message factory;
+ * may not be {@code null}
*
* @param factoryId the name of the factory to find, which is
* a system property
* @param defaultClassName the implementation class name, which is
* to be used only if nothing else
- * is found; null to indicate
+ * is found; {@code null} to indicate
* that there is no default class name
* @param tryFallback whether to try the default class as a
* fallback
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/soap/MessageFactory.java
--- a/src/java.xml.ws/share/classes/javax/xml/soap/MessageFactory.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/soap/MessageFactory.java Thu Jul 16 19:27:53 2015 -0700
@@ -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
@@ -30,36 +30,36 @@
import java.io.InputStream;
/**
- * A factory for creating SOAPMessage objects.
+ * A factory for creating {@code SOAPMessage} objects.
*
- * A SAAJ client can create a MessageFactory object
- * using the method newInstance, as shown in the following
+ * A SAAJ client can create a {@code MessageFactory} object
+ * using the method {@code newInstance}, as shown in the following
* lines of code.
- *
+ * {@code
* MessageFactory mf = MessageFactory.newInstance();
* MessageFactory mf12 = MessageFactory.newInstance(SOAPConstants.SOAP_1_2_PROTOCOL);
- *
+ * }
*
- * All MessageFactory objects, regardless of how they are
- * created, will produce SOAPMessage objects that
+ * All {@code MessageFactory} objects, regardless of how they are
+ * created, will produce {@code SOAPMessage} objects that
* have the following elements by default:
*
SOAPPart object
- * SOAPEnvelope object
- * SOAPBody object
- * SOAPHeader object
+ * SOAPHeader object and the
- * SOAPBody object.
- * The content of a new SOAPMessage object depends on which of the two
- * MessageFactory methods is used to create it.
+ * prepopulated with additional entries in the {@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.
* createMessage() createMessage(MimeHeaders, java.io.InputStream) -- message has
- * content from the InputStream object and headers from the
- * MimeHeaders object MessageFactory object that is an instance
+ * Creates a new {@code MessageFactory} object that is an instance
* of the default implementation (SOAP 1.1),
*
* This method uses the following ordered lookup procedure to determine the MessageFactory implementation class to load:
@@ -90,11 +90,11 @@
* MessageFactory
+ * @return a new instance of a {@code MessageFactory}
*
* @exception SOAPException if there was an error in creating the
* default implementation of the
- * MessageFactory.
+ * {@code MessageFactory}.
* @see SAAJMetaFactory
*/
@@ -121,26 +121,26 @@
}
/**
- * Creates a new MessageFactory object that is an instance
+ * Creates a new {@code MessageFactory} object that is an instance
* of the specified implementation. May be a dynamic message factory,
* a SOAP 1.1 message factory, or a SOAP 1.2 message factory. A dynamic
* message factory creates messages based on the MIME headers specified
- * as arguments to the createMessage method.
+ * as arguments to the {@code createMessage} method.
*
* This method uses the SAAJMetaFactory to locate the implementation class
* and create the MessageFactory instance.
*
- * @return a new instance of a MessageFactory
+ * @return a new instance of a {@code MessageFactory}
*
* @param protocol a string constant representing the class of the
* specified message factory implementation. May be
- * either DYNAMIC_SOAP_PROTOCOL,
- * DEFAULT_SOAP_PROTOCOL (which is the same
- * as) SOAP_1_1_PROTOCOL, or
- * SOAP_1_2_PROTOCOL.
+ * either {@code DYNAMIC_SOAP_PROTOCOL},
+ * {@code DEFAULT_SOAP_PROTOCOL} (which is the same
+ * as) {@code SOAP_1_1_PROTOCOL}, or
+ * {@code SOAP_1_2_PROTOCOL}.
*
* @exception SOAPException if there was an error in creating the
- * specified implementation of MessageFactory.
+ * specified implementation of {@code MessageFactory}.
* @see SAAJMetaFactory
* @since 1.6, SAAJ 1.3
*/
@@ -149,52 +149,52 @@
}
/**
- * Creates a new SOAPMessage object with the default
- * SOAPPart, SOAPEnvelope, SOAPBody,
- * and SOAPHeader objects. Profile-specific message factories
- * can choose to prepopulate the SOAPMessage object with
+ * 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} object with
* profile-specific headers.
*
- * Content can be added to this message's SOAPPart object, and
+ * 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 SOAPMessage object needs
- * to create one or more AttachmentPart objects and
+ * is sufficient. 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 AttachmentPart object.
+ * in an {@code AttachmentPart} object.
*
- * @return a new SOAPMessage object
+ * @return a new {@code SOAPMessage} object
* @exception SOAPException if a SOAP error occurs
* @exception UnsupportedOperationException if the protocol of this
- * MessageFactory instance is DYNAMIC_SOAP_PROTOCOL
+ * {@code MessageFactory} instance is {@code DYNAMIC_SOAP_PROTOCOL}
*/
public abstract SOAPMessage createMessage()
throws SOAPException;
/**
- * Internalizes the contents of the given InputStream object into a
- * new SOAPMessage object and returns the SOAPMessage
+ * Internalizes the contents of the given {@code InputStream} object into a
+ * new {@code SOAPMessage} object and returns the {@code SOAPMessage}
* object.
*
- * @param in the InputStream object that contains the data
+ * @param in the {@code InputStream} object that contains the data
* for a message
* @param headers the transport-specific headers passed to the
* message in a transport-independent fashion for creation of the
* message
- * @return a new SOAPMessage object containing the data from
- * the given InputStream object
+ * @return a new {@code SOAPMessage} object containing the data from
+ * the given {@code InputStream} object
*
* @exception IOException if there is a problem in reading data from
* the input stream
*
* @exception SOAPException may be thrown if the message is invalid
*
- * @exception IllegalArgumentException if the MessageFactory
+ * @exception IllegalArgumentException if the {@code MessageFactory}
* requires one or more MIME headers to be present in the
- * headers parameter and they are missing.
- * MessageFactory implementations for
- * SOAP_1_1_PROTOCOL or
- * SOAP_1_2_PROTOCOL must not throw
- * IllegalArgumentException for this reason.
+ * {@code headers} parameter and they are missing.
+ * {@code MessageFactory} implementations for
+ * {@code SOAP_1_1_PROTOCOL} or
+ * {@code SOAP_1_2_PROTOCOL} must not throw
+ * {@code IllegalArgumentException} for this reason.
*/
public abstract SOAPMessage createMessage(MimeHeaders headers,
InputStream in)
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/soap/MimeHeader.java
--- a/src/java.xml.ws/share/classes/javax/xml/soap/MimeHeader.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/soap/MimeHeader.java Thu Jul 16 19:27:53 2015 -0700
@@ -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,7 +28,7 @@
/**
* An object that stores a MIME header name and its value. One or more
- * MimeHeader objects may be contained in a MimeHeaders
+ * {@code MimeHeader} objects may be contained in a {@code MimeHeaders}
* object.
*
* @see MimeHeaders
@@ -40,11 +40,11 @@
private String value;
/**
- * Constructs a MimeHeader object initialized with the given
+ * Constructs a {@code MimeHeader} object initialized with the given
* name and value.
*
- * @param name a String giving the name of the header
- * @param value a String giving the value of the header
+ * @param name a {@code String} giving the name of the header
+ * @param value a {@code String} giving the value of the header
*/
public MimeHeader(String name, String value) {
this.name = name;
@@ -52,18 +52,18 @@
}
/**
- * Returns the name of this MimeHeader object.
+ * Returns the name of this {@code MimeHeader} object.
*
- * @return the name of the header as a String
+ * @return the name of the header as a {@code String}
*/
public String getName() {
return name;
}
/**
- * Returns the value of this MimeHeader object.
+ * Returns the value of this {@code MimeHeader} object.
*
- * @return the value of the header as a String
+ * @return the value of the header as a {@code String}
*/
public String getValue() {
return value;
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/soap/MimeHeaders.java
--- a/src/java.xml.ws/share/classes/javax/xml/soap/MimeHeaders.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/soap/MimeHeaders.java Thu Jul 16 19:27:53 2015 -0700
@@ -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
@@ -29,13 +29,13 @@
import java.util.Vector;
/**
- * A container for MimeHeader objects, which represent
+ * A container for {@code MimeHeader} objects, which represent
* the MIME headers present in a MIME part of a message.
*
*
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
- * AttachmentPart and other MIME dependent parts of the SAAJ
+ * {@code AttachmentPart} and other MIME dependent parts of the SAAJ
* API.
* @see SOAPMessage#getAttachments
* @see AttachmentPart
@@ -45,8 +45,8 @@
private Vector headers;
/**
- * Constructs a default MimeHeaders object initialized with
- * an empty Vector object.
+ * Constructs a default {@code MimeHeaders} object initialized with
+ * an empty {@code Vector} object.
*/
public MimeHeaders() {
headers = new Vector();
@@ -54,10 +54,10 @@
/**
* Returns all of the values for the specified header as an array of
- * String objects.
+ * {@code String} objects.
*
* @param name the name of the header for which values will be returned
- * @return a String array with all of the values for the
+ * @return a {@code String} array with all of the values for the
* specified header
* @see #setHeader
*/
@@ -86,9 +86,9 @@
*
* Note that RFC822 headers can contain only US-ASCII characters.
*
- * @param name a String with the name of the header for
+ * @param name a {@code String} with the name of the header for
* which to search
- * @param value a String with the value that will replace the
+ * @param value a {@code String} with the value that will replace the
* current value of the specified header
*
* @exception IllegalArgumentException if there was a problem in the
@@ -120,14 +120,14 @@
}
/**
- * Adds a MimeHeader object with the specified name and value
- * to this MimeHeaders object's list of headers.
+ * Adds a {@code MimeHeader} object with the specified name and value
+ * to this {@code MimeHeaders} object's list of headers.
*
* Note that RFC822 headers can contain only US-ASCII characters.
*
- * @param name a String with the name of the header to
+ * @param name a {@code String} with the name of the header to
* be added
- * @param value a String with the value of the header to
+ * @param value a {@code String} with the value of the header to
* be added
*
* @exception IllegalArgumentException if there was a problem in the
@@ -152,10 +152,10 @@
}
/**
- * Remove all MimeHeader objects whose name matches the
+ * Remove all {@code MimeHeader} objects whose name matches the
* given name.
*
- * @param name a String with the name of the header for
+ * @param name a {@code String} with the name of the header for
* which to search
*/
public void removeHeader(String name) {
@@ -167,7 +167,7 @@
}
/**
- * Removes all the header entries from this MimeHeaders object.
+ * Removes all the header entries from this {@code MimeHeaders} object.
*/
public void removeAllHeaders() {
headers.removeAllElements();
@@ -175,10 +175,10 @@
/**
- * Returns all the MimeHeaders in this MimeHeaders object.
+ * Returns all the {@code MimeHeader}s in this {@code MimeHeaders} object.
*
- * @return an Iterator object over this MimeHeaders
- * object's list of MimeHeader objects
+ * @return an {@code Iterator} object over this {@code MimeHeaders}
+ * object's list of {@code MimeHeader} objects
*/
public Iterator getAllHeaders() {
return headers.iterator();
@@ -243,12 +243,12 @@
/**
- * Returns all the MimeHeader objects whose name matches
+ * Returns all the {@code MimeHeader} objects whose name matches
* a name in the given array of names.
*
- * @param names an array of String objects with the names
+ * @param names an array of {@code String} objects with the names
* for which to search
- * @return an Iterator object over the MimeHeader
+ * @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) {
@@ -256,12 +256,12 @@
}
/**
- * Returns all of the MimeHeader objects whose name does not
+ * 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 String objects with the names
+ * @param names an array of {@code String} objects with the names
* for which to search
- * @return an Iterator object over the MimeHeader
+ * @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) {
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/soap/Name.java
--- a/src/java.xml.ws/share/classes/javax/xml/soap/Name.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/soap/Name.java Thu Jul 16 19:27:53 2015 -0700
@@ -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
@@ -55,17 +55,17 @@
* The following line of
* code, in which se is a {@code SOAPEnvelope} object, creates a new
* {@code Name} object with all three.
- *
+ * {@code
* Name name = se.createName("GetLastTradePrice", "WOMBAT",
* "http://www.wombat.org/trader");
- *
+ * }
* The following line of code gives an example of how a {@code Name} object
* can be used. The variable element is a {@code SOAPElement} object.
* This code creates a new {@code SOAPElement} object with the given name and
* adds it to element.
- *
+ * {@code
* element.addChildElement(name);
- *
+ * }
*
* The {@code Name} interface may be deprecated in a future release of SAAJ
* in favor of {@code javax.xml.namespace.QName}
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/soap/Node.java
--- a/src/java.xml.ws/share/classes/javax/xml/soap/Node.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/soap/Node.java Thu Jul 16 19:27:53 2015 -0700
@@ -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
@@ -35,19 +35,19 @@
*/
public interface Node extends org.w3c.dom.Node {
/**
- * Returns the value of this node if this is a Text node or the
+ * Returns the value of this node if this is a {@code Text} node or the
* value of the immediate child of this node otherwise.
- * If there is an immediate child of this Node that it is a
- * Text node then it's value will be returned. If there is
- * more than one Text node then the value of the first
- * Text Node will be returned.
- * Otherwise null is returned.
+ * If there is an immediate child of this {@code Node} that it is a
+ * {@code Text} node then it's value will be returned. If there is
+ * more than one {@code Text} node then the value of the first
+ * {@code Text} Node will be returned.
+ * Otherwise {@code null} is returned.
*
- * @return a String with the text of this node if this is a
- * Text node or the text contained by the first
- * immediate child of this Node object that is a
- * Text object if such a child exists;
- * null otherwise.
+ * @return a {@code String} with the text of this node if this is a
+ * {@code Text} node or the text contained by the first
+ * immediate child of this {@code Node} object that is a
+ * {@code Text} object if such a child exists;
+ * {@code null} otherwise.
*/
public String getValue();
@@ -55,24 +55,24 @@
* If this is a Text node then this method will set its value,
* otherwise it sets the value of the immediate (Text) child of this node.
* The value of the immediate child of this node can be set only if, there is
- * one child node and that node is a Text node, or if
- * there are no children in which case a child Text node will be
+ * one child node and that node is a {@code Text} node, or if
+ * there are no children in which case a child {@code Text} node will be
* created.
*
- * @exception IllegalStateException if the node is not a Text
+ * @exception IllegalStateException if the node is not a {@code Text}
* node and either has more than one child node or has a child
- * node that is not a Text node.
+ * node that is not a {@code Text} node.
*
* @since 1.6, SAAJ 1.2
*/
public void setValue(String value);
/**
- * Sets the parent of this Node object to the given
- * SOAPElement object.
+ * Sets the parent of this {@code Node} object to the given
+ * {@code SOAPElement} object.
*
- * @param parent the SOAPElement object to be set as
- * the parent of this Node object
+ * @param parent the {@code SOAPElement} object to be set as
+ * the parent of this {@code Node} object
*
* @exception SOAPException if there is a problem in setting the
* parent to the given element
@@ -81,13 +81,13 @@
public void setParentElement(SOAPElement parent) throws SOAPException;
/**
- * Returns the parent element of this Node object.
- * This method can throw an UnsupportedOperationException
+ * 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 SOAPElement object that is the parent of
- * this Node object or null if this
- * Node 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
*
* @exception UnsupportedOperationException if the whole tree is not
* kept in memory
@@ -96,18 +96,18 @@
public SOAPElement getParentElement();
/**
- * Removes this Node object from the tree.
+ * Removes this {@code Node} object from the tree.
*/
public void detachNode();
/**
- * Notifies the implementation that this Node
+ * 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.
*
- * Calling the method recycleNode implies that the method
- * detachNode has been called previously.
+ * Calling the method {@code recycleNode} implies that the method
+ * {@code detachNode} has been called previously.
*/
public void recycleNode();
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/soap/SAAJMetaFactory.java
--- a/src/java.xml.ws/share/classes/javax/xml/soap/SAAJMetaFactory.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/soap/SAAJMetaFactory.java Thu Jul 16 19:27:53 2015 -0700
@@ -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
@@ -27,9 +27,9 @@
/**
* The access point for the implementation classes of the factories defined in the
-* SAAJ API. All of the newInstance methods defined on factories in
+* SAAJ API. All of the {@code newInstance} methods defined on factories in
* SAAJ 1.3 defer to instances of this class to do the actual object creation.
-* The implementations of newInstance() methods (in SOAPFactory and MessageFactory)
+* The implementations of {@code newInstance()} methods (in SOAPFactory and MessageFactory)
* that existed in SAAJ 1.2 have been updated to also delegate to the SAAJMetaFactory when the SAAJ 1.2
* defined lookup fails to locate the Factory implementation class name.
*
@@ -48,10 +48,10 @@
"com.sun.xml.internal.messaging.saaj.soap.SAAJMetaFactoryImpl";
/**
- * Creates a new instance of a concrete SAAJMetaFactory object.
+ * Creates a new instance of a concrete {@code SAAJMetaFactory} object.
* The SAAJMetaFactory is an SPI, it pulls the creation of the other factories together into a
* single place. Changing out the SAAJMetaFactory has the effect of changing out the entire SAAJ
- * implementation. Service providers provide the name of their SAAJMetaFactory
+ * implementation. Service providers provide the name of their {@code SAAJMetaFactory}
* implementation.
*
* This method uses the following ordered lookup procedure to determine the SAAJMetaFactory implementation class to load:
@@ -65,8 +65,8 @@
*
SAAJMetaFactory object
- * @exception SOAPException if there is an error in creating the SAAJMetaFactory
+ * @return a concrete {@code SAAJMetaFactory} object
+ * @exception SOAPException if there is an error in creating the {@code SAAJMetaFactory}
*/
static SAAJMetaFactory getInstance() throws SOAPException {
try {
@@ -84,10 +84,10 @@
protected SAAJMetaFactory() { }
/**
- * Creates a MessageFactory object for
- * the given String protocol.
+ * Creates a {@code MessageFactory} object for
+ * the given {@code String} protocol.
*
- * @param protocol a String indicating the protocol
+ * @param protocol a {@code String} indicating the protocol
* @exception SOAPException if there is an error in creating the
* MessageFactory
* @see SOAPConstants#SOAP_1_1_PROTOCOL
@@ -98,10 +98,10 @@
throws SOAPException;
/**
- * Creates a SOAPFactory object for
- * the given String protocol.
+ * Creates a {@code SOAPFactory} object for
+ * the given {@code String} protocol.
*
- * @param protocol a String indicating the protocol
+ * @param protocol a {@code String} indicating the protocol
* @exception SOAPException if there is an error in creating the
* SOAPFactory
* @see SOAPConstants#SOAP_1_1_PROTOCOL
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/soap/SAAJResult.java
--- a/src/java.xml.ws/share/classes/javax/xml/soap/SAAJResult.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/soap/SAAJResult.java Thu Jul 16 19:27:53 2015 -0700
@@ -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
@@ -40,18 +40,18 @@
public class SAAJResult extends DOMResult {
/**
- * Creates a SAAJResult that will present results in the form
+ * Creates a {@code SAAJResult} that will present results in the form
* of a SAAJ tree that supports the default (SOAP 1.1) protocol.
*
- * This kind of SAAJResult is meant for use in situations where the
+ * This kind of {@code SAAJResult} is meant for use in situations where the
* results will be used as a parameter to a method that takes a parameter
- * whose type, such as SOAPElement, is drawn from the SAAJ
+ * whose type, such as {@code SOAPElement}, is drawn from the SAAJ
* API. When used in a transformation, the results are populated into the
- * SOAPPart of a SOAPMessage that is created internally.
- * The SOAPPart returned by {@link DOMResult#getNode()}
+ * {@code SOAPPart} of a {@code SOAPMessage} that is created internally.
+ * The {@code SOAPPart} returned by {@link DOMResult#getNode()}
* is not guaranteed to be well-formed.
*
- * @throws SOAPException if there is a problem creating a SOAPMessage
+ * @throws SOAPException if there is a problem creating a {@code SOAPMessage}
*
* @since 1.6, SAAJ 1.3
*/
@@ -60,23 +60,23 @@
}
/**
- * Creates a SAAJResult that will present results in the form
+ * Creates a {@code SAAJResult} that will present results in the form
* of a SAAJ tree that supports the specified protocol. The
- * DYNAMIC_SOAP_PROTOCOL is ambiguous in this context and will
- * cause this constructor to throw an UnsupportedOperationException.
+ * {@code DYNAMIC_SOAP_PROTOCOL} is ambiguous in this context and will
+ * cause this constructor to throw an {@code UnsupportedOperationException}.
*
- * This kind of SAAJResult is meant for use in situations where the
+ * This kind of {@code SAAJResult} is meant for use in situations where the
* results will be used as a parameter to a method that takes a parameter
- * whose type, such as SOAPElement, is drawn from the SAAJ
+ * whose type, such as {@code SOAPElement}, is drawn from the SAAJ
* API. When used in a transformation the results are populated into the
- * SOAPPart of a SOAPMessage that is created
- * internally. The SOAPPart returned by {@link DOMResult#getNode()}
+ * {@code SOAPPart} of a {@code SOAPMessage} that is created
+ * internally. The {@code SOAPPart} returned by {@link DOMResult#getNode()}
* is not guaranteed to be well-formed.
*
* @param protocol - the name of the SOAP protocol that the resulting SAAJ
* tree should support
*
- * @throws SOAPException if a SOAPMessage supporting the
+ * @throws SOAPException if a {@code SOAPMessage} supporting the
* specified protocol cannot be created
*
* @since 1.6, SAAJ 1.3
@@ -86,16 +86,16 @@
}
/**
- * Creates a SAAJResult that will write the results into the
- * SOAPPart of the supplied SOAPMessage.
+ * Creates a {@code SAAJResult} that will write the results into the
+ * {@code SOAPPart} of the supplied {@code SOAPMessage}.
* In the normal case these results will be written using DOM APIs and,
- * as a result, the finished SOAPPart will not be guaranteed
+ * as a result, the finished {@code SOAPPart} will not be guaranteed
* to be well-formed unless the data used to create it is also well formed.
- * When used in a transformation the validity of the SOAPMessage
+ * When used in a transformation the validity of the {@code SOAPMessage}
* after the transformation can be guaranteed only by means outside SAAJ
* specification.
*
- * @param message - the message whose SOAPPart will be
+ * @param message - the message whose {@code SOAPPart} will be
* populated as a result of some transformation or
* marshalling operation
*
@@ -106,11 +106,11 @@
}
/**
- * Creates a SAAJResult that will write the results as a
- * child node of the SOAPElement specified. In the normal
+ * Creates a {@code SAAJResult} that will write the results as a
+ * child node of the {@code SOAPElement} specified. In the normal
* case these results will be written using DOM APIs and as a result may
* invalidate the structure of the SAAJ tree. This kind of
- * SAAJResult should only be used when the validity of the
+ * {@code SAAJResult} should only be used when the validity of the
* incoming data can be guaranteed by means outside of the SAAJ
* specification.
*
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/soap/SOAPBody.java
--- a/src/java.xml.ws/share/classes/javax/xml/soap/SOAPBody.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/soap/SOAPBody.java Thu Jul 16 19:27:53 2015 -0700
@@ -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
@@ -258,7 +258,7 @@
public SOAPBodyElement addBodyElement(QName qname) throws SOAPException;
/**
- * Adds the root node of the DOM {@link org.w3c.dom.Document}
+ * Adds the root node of the DOM {@link org.w3c.dom.Document}
* to this {@code SOAPBody} object.
*
* Calling this method invalidates the {@code document} parameter.
@@ -279,12 +279,12 @@
throws SOAPException;
/**
- * Creates a new DOM {@link org.w3c.dom.Document} and sets
+ * Creates a new DOM {@link org.w3c.dom.Document} and sets
* the first child of this {@code SOAPBody} as it's document
* element. The child {@code SOAPElement} is removed as part of the
* process.
*
- * @return the {@link org.w3c.dom.Document} representation
+ * @return the {@link org.w3c.dom.Document} representation
* of the {@code SOAPBody} content.
*
* @exception SOAPException
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/soap/SOAPBodyElement.java
--- a/src/java.xml.ws/share/classes/javax/xml/soap/SOAPBodyElement.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/soap/SOAPBodyElement.java Thu Jul 16 19:27:53 2015 -0700
@@ -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
@@ -26,18 +26,18 @@
package javax.xml.soap;
/**
- * A SOAPBodyElement object represents the contents in
- * a SOAPBody object. The SOAPFault interface
- * is a SOAPBodyElement 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.
*
- * A new SOAPBodyElement object can be created and added
- * to a SOAPBody object with the SOAPBody
- * method addBodyElement. In the following line of code,
- * sb is a SOAPBody object, and
- * myName is a Name 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.
+ * {@code
* SOAPBodyElement sbe = sb.addBodyElement(myName);
- *
+ * }
*
* @since 1.6
*/
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/soap/SOAPConnection.java
--- a/src/java.xml.ws/share/classes/javax/xml/soap/SOAPConnection.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/soap/SOAPConnection.java Thu Jul 16 19:27:53 2015 -0700
@@ -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
@@ -32,18 +32,18 @@
*
* The SOAPConnection class is optional. Some implementations may
* not implement this interface in which case the call to
- * SOAPConnectionFactory.newInstance() (see below) will
- * throw an UnsupportedOperationException.
+ * {@code SOAPConnectionFactory.newInstance()} (see below) will
+ * throw an {@code UnsupportedOperationException}.
*
- * A client can obtain a SOAPConnection object using a
+ * A client can obtain a {@code SOAPConnection} object using a
* {@link SOAPConnectionFactory} object as in the following example:
- *
+ *+ * 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 * SOAPConnectionFactory factory = SOAPConnectionFactory.newInstance(); * SOAPConnection con = factory.createConnection(); - *- * ASOAPConnectionobject can be used to send messages + * }
call, which sends the
+ * messages are sent using the method {@code call}, which sends the
* message and then waits until it gets a reply.
*
* @since 1.6
@@ -54,15 +54,15 @@
* Sends the given message to the specified endpoint and blocks until
* it has returned the response.
*
- * @param request the SOAPMessage object to be sent
- * @param to an Object that identifies
+ * @param request the {@code SOAPMessage} object to be sent
+ * @param to an {@code Object} that identifies
* where the message should be sent. It is required to
* support Objects of type
- * java.lang.String,
- * java.net.URL, and when JAXM is present
- * javax.xml.messaging.URLEndpoint
+ * {@code java.lang.String},
+ * {@code java.net.URL}, and when JAXM is present
+ * {@code javax.xml.messaging.URLEndpoint}
*
- * @return the SOAPMessage object that is the response to the
+ * @return the {@code SOAPMessage} object that is the response to the
* message that was sent
* @throws SOAPException if there is a SOAP error
*/
@@ -72,12 +72,12 @@
/**
* Gets a message from a specific endpoint and blocks until it receives,
*
- * @param to an Object that identifies where
+ * @param to an {@code Object} that identifies where
* the request should be sent. Objects of type
- * java.lang.String and
- * java.net.URL must be supported.
+ * {@code java.lang.String} and
+ * {@code java.net.URL} must be supported.
*
- * @return the SOAPMessage object that is the response to the
+ * @return the {@code SOAPMessage} object that is the response to the
* get message request
* @throws SOAPException if there is a SOAP error
* @since 1.6, SAAJ 1.3
@@ -88,7 +88,7 @@
}
/**
- * Closes this SOAPConnection object.
+ * Closes this {@code SOAPConnection} object.
*
* @throws SOAPException if there is a SOAP error
*/
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/soap/SOAPConnectionFactory.java
--- a/src/java.xml.ws/share/classes/javax/xml/soap/SOAPConnectionFactory.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/soap/SOAPConnectionFactory.java Thu Jul 16 19:27:53 2015 -0700
@@ -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
@@ -26,38 +26,38 @@
package javax.xml.soap;
/**
- * A factory for creating SOAPConnection objects. Implementation of this class
- * is optional. If SOAPConnectionFactory.newInstance() throws an
+ * A factory for creating {@code SOAPConnection} objects. Implementation of this class
+ * is optional. If {@code SOAPConnectionFactory.newInstance()} throws an
* UnsupportedOperationException then the implementation does not support the
* SAAJ communication infrastructure. Otherwise {@link SOAPConnection} objects
- * can be created by calling createConnection() on the newly
- * created SOAPConnectionFactory object.
+ * can be created by calling {@code createConnection()} on the newly
+ * created {@code SOAPConnectionFactory} object.
*
* @since 1.6
*/
public abstract class SOAPConnectionFactory {
/**
- * A constant representing the default value for a SOAPConnection
+ * A constant representing the default value for a {@code SOAPConnection}
* object. The default is the point-to-point SOAP connection.
*/
static final String DEFAULT_SOAP_CONNECTION_FACTORY
= "com.sun.xml.internal.messaging.saaj.client.p2p.HttpSOAPConnectionFactory";
/**
- * A constant representing the SOAPConnection class.
+ * A constant representing the {@code SOAPConnection} class.
*/
static private final String SF_PROPERTY
= "javax.xml.soap.SOAPConnectionFactory";
/**
* Creates an instance of the default
- * SOAPConnectionFactory object.
+ * {@code SOAPConnectionFactory} object.
*
* @return a new instance of a default
- * SOAPConnectionFactory object
+ * {@code SOAPConnectionFactory} object
*
* @exception SOAPException if there was an error creating the
- * SOAPConnectionFactory
+ * {@code SOAPConnectionFactory}
*
* @exception UnsupportedOperationException if newInstance is not
* supported.
@@ -76,12 +76,12 @@
}
/**
- * Create a new SOAPConnection.
+ * Create a new {@code SOAPConnection}.
*
- * @return the new SOAPConnection object.
+ * @return the new {@code SOAPConnection} object.
*
* @exception SOAPException if there was an exception creating the
- * SOAPConnection object.
+ * {@code SOAPConnection} object.
*/
public abstract SOAPConnection createConnection()
throws SOAPException;
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/soap/SOAPConstants.java
--- a/src/java.xml.ws/share/classes/javax/xml/soap/SOAPConstants.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/soap/SOAPConstants.java Thu Jul 16 19:27:53 2015 -0700
@@ -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
@@ -34,30 +34,30 @@
*/
public interface SOAPConstants {
/**
- * Used to create MessageFactory instances that create
- * SOAPMessages whose concrete type is based on the
- * Content-Type MIME header passed to the
- * createMessage method. If no Content-Type
- * header is passed then the createMessage may throw an
- * IllegalArgumentException or, in the case of the no
- * argument version of createMessage, an
- * UnsupportedOperationException.
+ * Used to create {@code MessageFactory} instances that create
+ * {@code SOAPMessages} whose concrete type is based on the
+ * {@code Content-Type} MIME header passed to the
+ * {@code createMessage} method. If no {@code Content-Type}
+ * header is passed then the {@code createMessage} may throw an
+ * {@code IllegalArgumentException} or, in the case of the no
+ * argument version of {@code createMessage}, an
+ * {@code UnsupportedOperationException}.
*
* @since 1.6, SAAJ 1.3
*/
public static final String DYNAMIC_SOAP_PROTOCOL = "Dynamic Protocol";
/**
- * Used to create MessageFactory instances that create
- * SOAPMessages whose behavior supports the SOAP 1.1 specification.
+ * Used to create {@code MessageFactory} instances that create
+ * {@code SOAPMessages} whose behavior supports the SOAP 1.1 specification.
*
* @since 1.6, SAAJ 1.3
*/
public static final String SOAP_1_1_PROTOCOL = "SOAP 1.1 Protocol";
/**
- * Used to create MessageFactory instances that create
- * SOAPMessages whose behavior supports the SOAP 1.2
+ * Used to create {@code MessageFactory} instances that create
+ * {@code SOAPMessages} whose behavior supports the SOAP 1.2
* specification
*
* @since 1.6, SAAJ 1.3
@@ -93,9 +93,9 @@
/**
* The namespace identifier for the SOAP 1.1 encoding.
- * An attribute named encodingStyle in the
- * URI_NS_SOAP_ENVELOPE namespace and set to the value
- * URI_NS_SOAP_ENCODING can be added to an element to indicate
+ * An attribute named {@code encodingStyle} in the
+ * {@code URI_NS_SOAP_ENVELOPE} namespace and set to the value
+ * {@code URI_NS_SOAP_ENCODING} can be added to an element to indicate
* that it is encoded using the rules in section 5 of the SOAP 1.1
* specification.
*/
@@ -110,14 +110,14 @@
URI_NS_SOAP_1_2_ENCODING = "http://www.w3.org/2003/05/soap-encoding";
/**
- * The media type of the Content-Type MIME header in SOAP 1.1.
+ * The media type of the {@code Content-Type} MIME header in SOAP 1.1.
* @since 1.6, SAAJ 1.3
*/
public static final String
SOAP_1_1_CONTENT_TYPE = "text/xml";
/**
- * The media type of the Content-Type MIME header in SOAP 1.2.
+ * The media type of the {@code Content-Type} MIME header in SOAP 1.2.
* @since 1.6, SAAJ 1.3
*/
public static final String
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/soap/SOAPElement.java
--- a/src/java.xml.ws/share/classes/javax/xml/soap/SOAPElement.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/soap/SOAPElement.java Thu Jul 16 19:27:53 2015 -0700
@@ -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
@@ -38,8 +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}
- * for details.
+ * {@link javax.xml.soap} for details.
*
* @since 1.6
*/
@@ -345,7 +344,7 @@
* 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
+ * {@link #getNamespaceURI(String)} if it were given
* {@code prefix} as it's parameter.
*
* @exception SOAPException if the {@code QName} cannot be created.
@@ -439,7 +438,7 @@
* have been obtained through DOM APIs as invalid and either discard them or
* 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 {@code SOAPElement}
@@ -461,7 +460,7 @@
* have been obtained through DOM APIs as invalid and either discard them or
* 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 {@code Name} object with the name of the child
@@ -488,7 +487,7 @@
* have been obtained through DOM APIs as invalid and either discard them or
* 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 {@code QName} object with the qname of the child
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/soap/SOAPElementFactory.java
--- a/src/java.xml.ws/share/classes/javax/xml/soap/SOAPElementFactory.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/soap/SOAPElementFactory.java Thu Jul 16 19:27:53 2015 -0700
@@ -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
@@ -26,16 +26,16 @@
package javax.xml.soap;
/**
- * SOAPElementFactory is a factory for XML fragments that
+ * {@code SOAPElementFactory} is a factory for XML fragments that
* will eventually end up in the SOAP part. These fragments
- * can be inserted as children of the SOAPHeader or
- * SOAPBody or SOAPEnvelope.
+ * can be inserted as children of the {@code SOAPHeader} or
+ * {@code SOAPBody} or {@code SOAPEnvelope}.
*
* Elements created using this factory do not have the properties
* of an element that lives inside a SOAP header document. These
* elements are copied into the XML document tree when they are
* inserted.
- * @deprecated - Use javax.xml.soap.SOAPFactory for creating SOAPElements.
+ * @deprecated - Use {@code javax.xml.soap.SOAPFactory} for creating SOAPElements.
* @see javax.xml.soap.SOAPFactory
* @since 1.6
*/
@@ -48,17 +48,17 @@
}
/**
- * Create a SOAPElement object initialized with the
- * given Name object.
+ * Create a {@code SOAPElement} object initialized with the
+ * given {@code Name} object.
*
- * @param name a Name object with the XML name for
+ * @param name a {@code Name} object with the XML name for
* the new element
*
- * @return the new SOAPElement object that was
+ * @return the new {@code SOAPElement} object that was
* created
*
* @exception SOAPException if there is an error in creating the
- * SOAPElement object
+ * {@code SOAPElement} object
*
* @deprecated Use
* javax.xml.soap.SOAPFactory.createElement(javax.xml.soap.Name)
@@ -72,17 +72,17 @@
}
/**
- * Create a SOAPElement object initialized with the
+ * Create a {@code SOAPElement} object initialized with the
* given local name.
*
- * @param localName a String giving the local name for
+ * @param localName a {@code String} giving the local name for
* the new element
*
- * @return the new SOAPElement object that was
+ * @return the new {@code SOAPElement} object that was
* created
*
* @exception SOAPException if there is an error in creating the
- * SOAPElement object
+ * {@code SOAPElement} object
*
* @deprecated Use
* javax.xml.soap.SOAPFactory.createElement(String localName) instead
@@ -94,17 +94,17 @@
}
/**
- * Create a new SOAPElement object with the given
+ * Create a new {@code SOAPElement} object with the given
* local name, prefix and uri.
*
- * @param localName a String giving the local name
+ * @param localName a {@code String} giving the local name
* for the new element
- * @param prefix the prefix for this SOAPElement
- * @param uri a String giving the URI of the
+ * @param prefix the prefix for this {@code SOAPElement}
+ * @param uri a {@code String} giving the URI of the
* namespace to which the new element belongs
*
* @exception SOAPException if there is an error in creating the
- * SOAPElement object
+ * {@code SOAPElement} object
*
* @deprecated Use
* javax.xml.soap.SOAPFactory.createElement(String localName,
@@ -120,12 +120,12 @@
}
/**
- * Creates a new instance of SOAPElementFactory.
+ * Creates a new instance of {@code SOAPElementFactory}.
*
- * @return a new instance of a SOAPElementFactory
+ * @return a new instance of a {@code SOAPElementFactory}
*
* @exception SOAPException if there was an error creating the
- * default SOAPElementFactory
+ * default {@code SOAPElementFactory}
*/
public static SOAPElementFactory newInstance() throws SOAPException {
try {
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/soap/SOAPEnvelope.java
--- a/src/java.xml.ws/share/classes/javax/xml/soap/SOAPEnvelope.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/soap/SOAPEnvelope.java Thu Jul 16 19:27:53 2015 -0700
@@ -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}.
+ * {@code
* se.getBody().detachNode();
- *
- * To create a SOAPHeader object to replace the one that was removed,
+ * }
+ * To create a {@code SOAPHeader} object to replace the one that was removed,
* a client uses
- * the method 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 aSOAPBodyorSOAPHeader+ * }
- * 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.
+ * {@code
* Name name = se.createName("GetLastTradePrice", "WOMBAT",
* "http://www.wombat.org/trader");
- *
+ * }
*
* @since 1.6
*/
public interface SOAPEnvelope extends SOAPElement {
/**
- * Creates a new 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;
}
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/soap/SOAPException.java
--- a/src/java.xml.ws/share/classes/javax/xml/soap/SOAPException.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/soap/SOAPException.java Thu Jul 16 19:27:53 2015 -0700
@@ -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
@@ -27,16 +27,16 @@
/**
* An exception that signals that a SOAP exception has occurred. A
- * SOAPException object may contain a String
+ * {@code SOAPException} object may contain a {@code String}
* that gives the reason for the exception, an embedded
- * Throwable object, or both. This class provides methods
+ * {@code Throwable} object, or both. This class provides methods
* for retrieving reason messages and for retrieving the embedded
- * Throwable object.
+ * {@code Throwable} object.
*
- *
Typical reasons for throwing a SOAPException
+ *
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 Throwable
+ * 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.
*
@@ -46,8 +46,8 @@
private Throwable cause;
/**
- * Constructs a SOAPException object with no
- * reason or embedded Throwable object.
+ * Constructs a {@code SOAPException} object with no
+ * reason or embedded {@code Throwable} object.
*/
public SOAPException() {
super();
@@ -55,8 +55,8 @@
}
/**
- * Constructs a SOAPException object with the given
- * String as the reason for the exception being thrown.
+ * 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
*/
@@ -66,14 +66,14 @@
}
/**
- * Constructs a SOAPException object with the given
- * String as the reason for the exception being thrown
- * and the given Throwable object as an embedded
+ * 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 Throwable object that is to
- * be embedded in this SOAPException object
+ * @param cause a {@code Throwable} object that is to
+ * be embedded in this {@code SOAPException} object
*/
public SOAPException(String reason, Throwable cause) {
super(reason);
@@ -81,8 +81,8 @@
}
/**
- * Constructs a SOAPException object initialized
- * with the given Throwable object.
+ * Constructs a {@code SOAPException} object initialized
+ * with the given {@code Throwable} object.
*/
public SOAPException(Throwable cause) {
super(cause.toString());
@@ -90,17 +90,17 @@
}
/**
- * Returns the detail message for this SOAPException
+ * Returns the detail message for this {@code SOAPException}
* object.
*
- * If there is an embedded Throwable object, and if the
- * SOAPException object has no detail message of its
+ * 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
- * Throwable object.
+ * {@code Throwable} object.
*
* @return the error or warning message for this
- * SOAPException or, if it has none, the
- * message of the embedded Throwable object,
+ * {@code SOAPException} or, if it has none, the
+ * message of the embedded {@code Throwable} object,
* if there is one
*/
public String getMessage() {
@@ -113,11 +113,11 @@
}
/**
- * Returns the Throwable object embedded in this
- * SOAPException if there is one. Otherwise, this method
- * returns null.
+ * Returns the {@code Throwable} object embedded in this
+ * {@code SOAPException} if there is one. Otherwise, this method
+ * returns {@code null}.
*
- * @return the embedded Throwable object or null
+ * @return the embedded {@code Throwable} object or {@code null}
* if there is none
*/
@@ -126,29 +126,29 @@
}
/**
- * Initializes the cause field of this SOAPException
- * object with the given Throwable object.
+ * Initializes the {@code cause} field of this {@code SOAPException}
+ * object with the given {@code Throwable} object.
*
* 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 SOAPException object.
- * If this SOAPException object was created with the
+ * returned a new {@code SOAPException} object.
+ * If this {@code SOAPException} object was created with the
* constructor {@link #SOAPException(Throwable)} or
* {@link #SOAPException(String,Throwable)}, meaning that its
- * cause field already has a value, this method cannot be
+ * {@code cause} field already has a value, this method cannot be
* called even once.
*
- * @param cause the Throwable object that caused this
- * SOAPException object to be thrown. The value of this
+ * @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
* {@link #getCause()} method. A null value is
* permitted and indicates that the cause is nonexistent or
* unknown.
- * @return a reference to this SOAPException instance
- * @throws IllegalArgumentException if cause is this
- * Throwable object. (A Throwable object
+ * @return a reference to this {@code SOAPException} instance
+ * @throws IllegalArgumentException if {@code cause} is this
+ * {@code Throwable} object. (A {@code Throwable} object
* cannot be its own cause.)
- * @throws IllegalStateException if the cause for this SOAPException object
+ * @throws IllegalStateException if the cause for this {@code SOAPException} object
* has already been initialized
*/
public synchronized Throwable initCause(Throwable cause) {
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/soap/SOAPFactory.java
--- a/src/java.xml.ws/share/classes/javax/xml/soap/SOAPFactory.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/soap/SOAPFactory.java Thu Jul 16 19:27:53 2015 -0700
@@ -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
@@ -30,18 +30,18 @@
import org.w3c.dom.Element;
/**
- * SOAPFactory is a factory for creating various objects
+ * {@code SOAPFactory} is a factory for creating various objects
* that exist in the SOAP XML tree.
- * SOAPFactory can be
+ * {@code SOAPFactory} can be
* used to create XML fragments that will eventually end up in the
* SOAP part. These fragments can be inserted as children of the
* {@link SOAPHeaderElement} or {@link SOAPBodyElement} or
* {@link SOAPEnvelope} or other {@link SOAPElement} objects.
*
- * SOAPFactory also has methods to create
- * javax.xml.soap.Detail objects as well as
- * java.xml.soap.Name objects.
+ * {@code SOAPFactory} also has methods to create
+ * {@code javax.xml.soap.Detail} objects as well as
+ * {@code java.xml.soap.Name} objects.
*
* @since 1.6
*/
@@ -49,34 +49,34 @@
/**
* A constant representing the property used to lookup the name of
- * a SOAPFactory implementation class.
+ * a {@code SOAPFactory} implementation class.
*/
static private final String SOAP_FACTORY_PROPERTY =
"javax.xml.soap.SOAPFactory";
/**
- * Class name of default SOAPFactory implementation.
+ * Class name of default {@code SOAPFactory} implementation.
*/
static final String DEFAULT_SOAP_FACTORY
= "com.sun.xml.internal.messaging.saaj.soap.ver1_1.SOAPFactory1_1Impl";
/**
- * Creates a SOAPElement object from an existing DOM
- * Element. If the DOM Element that is passed in
- * as an argument is already a SOAPElement then this method
+ * Creates a {@code SOAPElement} object from an existing DOM
+ * {@code Element}. If the DOM {@code Element} that is passed in
+ * as an argument is already a {@code SOAPElement} then this method
* must return it unmodified without any further work. Otherwise, a new
- * SOAPElement is created and a deep copy is made of the
- * domElement argument. The concrete type of the return value
- * will depend on the name of the domElement argument. If any
- * part of the tree rooted in domElement violates SOAP rules, a
- * SOAPException will be thrown.
+ * {@code SOAPElement} is created and a deep copy is made of the
+ * {@code domElement} argument. The concrete type of the return value
+ * will depend on the name of the {@code domElement} argument. If any
+ * part of the tree rooted in {@code domElement} violates SOAP rules, a
+ * {@code SOAPException} will be thrown.
*
- * @param domElement - the Element to be copied.
+ * @param domElement - the {@code Element} to be copied.
*
- * @return a new SOAPElement that is a copy of domElement.
+ * @return a new {@code SOAPElement} that is a copy of {@code domElement}.
*
* @exception SOAPException if there is an error in creating the
- * SOAPElement object
+ * {@code SOAPElement} object
*
* @since 1.6, SAAJ 1.3
*/
@@ -85,41 +85,41 @@
}
/**
- * Creates a SOAPElement object initialized with the
- * given Name object. The concrete type of the return value
- * will depend on the name given to the new SOAPElement. For
- * instance, a new SOAPElement with the name
+ * Creates a {@code SOAPElement} object initialized with the
+ * given {@code Name} object. The concrete type of the return value
+ * will depend on the name given to the new {@code SOAPElement}. For
+ * instance, a new {@code SOAPElement} with the name
* "{http://www.w3.org/2003/05/soap-envelope}Envelope" would cause a
- * SOAPEnvelope that supports SOAP 1.2 behavior to be created.
+ * {@code SOAPEnvelope} that supports SOAP 1.2 behavior to be created.
*
- * @param name a Name object with the XML name for
+ * @param name a {@code Name} object with the XML name for
* the new element
*
- * @return the new SOAPElement object that was
+ * @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 SOAPFactory#createElement(javax.xml.namespace.QName)
*/
public abstract SOAPElement createElement(Name name) throws SOAPException;
/**
- * Creates a SOAPElement object initialized with the
- * given QName object. The concrete type of the return value
- * will depend on the name given to the new SOAPElement. For
- * instance, a new SOAPElement with the name
+ * Creates a {@code SOAPElement} object initialized with the
+ * given {@code QName} object. The concrete type of the return value
+ * will depend on the name given to the new {@code SOAPElement}. For
+ * instance, a new {@code SOAPElement} with the name
* "{http://www.w3.org/2003/05/soap-envelope}Envelope" would cause a
- * SOAPEnvelope that supports SOAP 1.2 behavior to be created.
+ * {@code SOAPEnvelope} that supports SOAP 1.2 behavior to be created.
*
- * @param qname a QName object with the XML name for
+ * @param qname a {@code QName} object with the XML name for
* the new element
*
- * @return the new SOAPElement object that was
+ * @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 SOAPFactory#createElement(Name)
* @since 1.6, SAAJ 1.3
*/
@@ -128,38 +128,38 @@
}
/**
- * Creates a SOAPElement object initialized with the
+ * Creates a {@code SOAPElement} object initialized with the
* given local name.
*
- * @param localName a String giving the local name for
+ * @param localName a {@code String} giving the local name for
* the new element
*
- * @return the new SOAPElement object that was
+ * @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 abstract SOAPElement createElement(String localName)
throws SOAPException;
/**
- * Creates a new SOAPElement object with the given
+ * Creates a new {@code SOAPElement} object with the given
* local name, prefix and uri. The concrete type of the return value
- * will depend on the name given to the new SOAPElement. For
- * instance, a new SOAPElement with the name
+ * will depend on the name given to the new {@code SOAPElement}. For
+ * instance, a new {@code SOAPElement} with the name
* "{http://www.w3.org/2003/05/soap-envelope}Envelope" would cause a
- * SOAPEnvelope that supports SOAP 1.2 behavior to be created.
+ * {@code SOAPEnvelope} that supports SOAP 1.2 behavior to be created.
*
- * @param localName a String giving the local name
+ * @param localName a {@code String} giving the local name
* for the new element
- * @param prefix the prefix for this SOAPElement
- * @param uri a String giving the URI of the
+ * @param prefix the prefix for this {@code SOAPElement}
+ * @param uri a {@code String} giving the URI of the
* namespace to which the new element belongs
*
* @exception SOAPException if there is an error in creating the
- * SOAPElement object
+ * {@code SOAPElement} object
*/
public abstract SOAPElement createElement(
String localName,
@@ -168,51 +168,51 @@
throws SOAPException;
/**
- * Creates a new Detail object which serves as a container
- * for DetailEntry objects.
+ * Creates a new {@code Detail} object which serves as a container
+ * for {@code DetailEntry} objects.
*
- * This factory method creates Detail objects for use in
- * situations where it is not practical to use the SOAPFault
+ * This factory method creates {@code Detail} objects for use in
+ * situations where it is not practical to use the {@code SOAPFault}
* abstraction.
*
- * @return a Detail object
+ * @return a {@code Detail} object
* @throws SOAPException if there is a SOAP error
* @throws UnsupportedOperationException if the protocol specified
- * for the SOAPFactory was DYNAMIC_SOAP_PROTOCOL
+ * for the SOAPFactory was {@code DYNAMIC_SOAP_PROTOCOL}
*/
public abstract Detail createDetail() throws SOAPException;
/**
- *Creates a new SOAPFault object initialized with the given reasonText
- * and faultCode
+ *Creates a new {@code SOAPFault} object initialized with the given {@code reasonText}
+ * and {@code faultCode}
*@param reasonText the ReasonText/FaultString for the fault
*@param faultCode the FaultCode for the fault
- *@return a SOAPFault object
+ *@return a {@code SOAPFault} object
*@throws SOAPException if there is a SOAP error
*@since 1.6, SAAJ 1.3
*/
public abstract SOAPFault createFault(String reasonText, QName faultCode) throws SOAPException;
/**
- *Creates a new default SOAPFault object
- *@return a SOAPFault object
+ *Creates a new default {@code SOAPFault} object
+ *@return a {@code SOAPFault} object
*@throws SOAPException if there is a SOAP error
*@since 1.6, SAAJ 1.3
*/
public abstract SOAPFault createFault() throws SOAPException;
/**
- * Creates a new 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
- * situations where it is not practical to use the SOAPEnvelope
+ * This factory method creates {@code Name} objects for use in
+ * situations where it is not practical to use the {@code SOAPEnvelope}
* abstraction.
*
- * @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
*/
@@ -223,22 +223,22 @@
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
- * situations where it is not practical to use the SOAPEnvelope
+ * This factory method creates {@code Name} objects for use in
+ * situations where it is not practical to use the {@code SOAPEnvelope}
* abstraction.
*
- * @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
*/
public abstract Name createName(String localName) throws SOAPException;
/**
- * Creates a new SOAPFactory object that is an instance of
+ * Creates a new {@code SOAPFactory} object that is an instance of
* the default implementation (SOAP 1.1),
*
* This method uses the following ordered lookup procedure to determine the SOAPFactory implementation class to load:
@@ -252,10 +252,10 @@
*
SOAPFactory
+ * @return a new instance of a {@code SOAPFactory}
*
* @exception SOAPException if there was an error creating the
- * default SOAPFactory
+ * default {@code SOAPFactory}
* @see SAAJMetaFactory
*/
public static SOAPFactory newInstance()
@@ -275,21 +275,21 @@
}
/**
- * Creates a new SOAPFactory object that is an instance of
+ * Creates a new {@code SOAPFactory} object that is an instance of
* the specified implementation, this method uses the SAAJMetaFactory to
* locate the implementation class and create the SOAPFactory instance.
*
- * @return a new instance of a SOAPFactory
+ * @return a new instance of a {@code SOAPFactory}
*
* @param protocol a string constant representing the protocol of the
* specified SOAP factory implementation. May be
- * either DYNAMIC_SOAP_PROTOCOL,
- * DEFAULT_SOAP_PROTOCOL (which is the same
- * as) SOAP_1_1_PROTOCOL, or
- * SOAP_1_2_PROTOCOL.
+ * either {@code DYNAMIC_SOAP_PROTOCOL},
+ * {@code DEFAULT_SOAP_PROTOCOL} (which is the same
+ * as) {@code SOAP_1_1_PROTOCOL}, or
+ * {@code SOAP_1_2_PROTOCOL}.
*
* @exception SOAPException if there was an error creating the
- * specified SOAPFactory
+ * specified {@code SOAPFactory}
* @see SAAJMetaFactory
* @since 1.6, SAAJ 1.3
*/
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/soap/SOAPFault.java
--- a/src/java.xml.ws/share/classes/javax/xml/soap/SOAPFault.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/soap/SOAPFault.java Thu Jul 16 19:27:53 2015 -0700
@@ -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
@@ -31,16 +31,16 @@
import javax.xml.namespace.QName;
/**
- * An element in the SOAPBody object that contains
+ * An element in the {@code SOAPBody} object that contains
* error and/or status information. This information may relate to
- * errors in the SOAPMessage object or to problems
+ * errors in the {@code SOAPMessage} object or to problems
* that are not related to the content in the message itself. Problems
* not related to the message itself are generally errors in
* processing, such as the inability to communicate with an upstream
* server.
*
- * Depending on the protocol specified while creating the
- * MessageFactory instance, a SOAPFault has
+ * Depending on the {@code protocol} specified while creating the
+ * {@code MessageFactory} instance, a {@code SOAPFault} has
* sub-elements as defined in the SOAP 1.1/SOAP 1.2 specification.
*
* @since 1.6
@@ -48,14 +48,14 @@
public interface SOAPFault extends SOAPBodyElement {
/**
- * Sets this SOAPFault object with the given fault code.
+ * Sets this {@code SOAPFault} object with the given fault code.
*
*
Fault codes, which give information about the fault, are defined
* in the SOAP 1.1 specification. A fault code is mandatory and must
- * be of type Name. This method provides a convenient
+ * be of type {@code Name}. This method provides a convenient
* way to set a fault code. For example,
*
- *
+ * {@code
* SOAPEnvelope se = ...;
* // Create a qualified name in the SOAP namespace with a localName
* // of "Client". Note that prefix parameter is optional and is null
@@ -64,10 +64,10 @@
* SOAPConstants.URI_NS_SOAP_ENVELOPE);
* SOAPFault fault = ...;
* fault.setFaultCode(qname);
- *
+ * }
* It is preferable to use this method over {@link #setFaultCode(String)}.
*
- * @param faultCodeQName a Name object giving the fault
+ * @param faultCodeQName a {@code Name} object giving the fault
* code to be set. It must be namespace qualified.
* @see #getFaultCodeAsName
*
@@ -79,16 +79,16 @@
public void setFaultCode(Name faultCodeQName) throws SOAPException;
/**
- * Sets this SOAPFault object with the given fault code.
+ * Sets this {@code SOAPFault} object with the given fault code.
*
* It is preferable to use this method over {@link #setFaultCode(Name)}.
*
- * @param faultCodeQName a QName object giving the fault
+ * @param faultCodeQName a {@code QName} object giving the fault
* code to be set. It must be namespace qualified.
* @see #getFaultCodeAsQName
*
* @exception SOAPException if there was an error in adding the
- * faultcode element to the underlying XML tree.
+ * {@code faultcode} element to the underlying XML tree.
*
* @see #setFaultCode(Name)
* @see #getFaultCodeAsQName()
@@ -98,14 +98,14 @@
public void setFaultCode(QName faultCodeQName) throws SOAPException;
/**
- * Sets this SOAPFault object with the give fault code.
+ * Sets this {@code SOAPFault} object with the give fault code.
*
* Fault codes, which given information about the fault, are defined in
* the SOAP 1.1 specification. This element is mandatory in SOAP 1.1.
* Because the fault code is required to be a QName it is preferable to
* use the {@link #setFaultCode(Name)} form of this method.
*
- * @param faultCode a String giving the fault code to be set.
+ * @param faultCode a {@code String} giving the fault code to be set.
* It must be of the form "prefix:localName" where the prefix has
* been defined in a namespace declaration.
* @see #setFaultCode(Name)
@@ -113,21 +113,21 @@
* @see SOAPElement#addNamespaceDeclaration
*
* @exception SOAPException if there was an error in adding the
- * faultCode to the underlying XML tree.
+ * {@code faultCode} to the underlying XML tree.
*/
public void setFaultCode(String faultCode) throws SOAPException;
/**
* Gets the mandatory SOAP 1.1 fault code for this
- * SOAPFault object as a SAAJ Name object.
+ * {@code SOAPFault} object as a SAAJ {@code Name} object.
* The SOAP 1.1 specification requires the value of the "faultcode"
* element to be of type QName. This method returns the content of the
* element as a QName in the form of a SAAJ Name object. This method
- * should be used instead of the getFaultCode method since
+ * should be used instead of the {@code getFaultCode} method since
* it allows applications to easily access the namespace name without
* additional parsing.
*
- * @return a Name representing the faultcode
+ * @return a {@code Name} representing the faultcode
* @see #setFaultCode(Name)
*
* @since 1.6, SAAJ 1.2
@@ -137,9 +137,9 @@
/**
* Gets the fault code for this
- * SOAPFault object as a QName object.
+ * {@code SOAPFault} object as a {@code QName} object.
*
- * @return a QName representing the faultcode
+ * @return a {@code QName} representing the faultcode
*
* @see #setFaultCode(QName)
*
@@ -148,12 +148,12 @@
public QName getFaultCodeAsQName();
/**
- * Gets the Subcodes for this SOAPFault as an iterator over
- * QNames.
+ * Gets the Subcodes for this {@code SOAPFault} as an iterator over
+ * {@code QNames}.
*
- * @return an Iterator that accesses a sequence of
- * QNames. This Iterator should not support
- * the optional remove method. The order in which the
+ * @return an {@code Iterator} that accesses a sequence of
+ * {@code QNames}. This {@code Iterator} should not support
+ * the optional {@code remove} method. The order in which the
* Subcodes are returned reflects the hierarchy of Subcodes present
* in the fault from top to bottom.
*
@@ -166,9 +166,9 @@
/**
* Removes any Subcodes that may be contained by this
- * SOAPFault. Subsequent calls to
- * getFaultSubcodes will return an empty iterator until a call
- * to appendFaultSubcode is made.
+ * {@code SOAPFault}. Subsequent calls to
+ * {@code getFaultSubcodes} will return an empty iterator until a call
+ * to {@code appendFaultSubcode} is made.
*
* @exception UnsupportedOperationException if this message does not
* support the SOAP 1.2 concept of Subcode.
@@ -179,7 +179,7 @@
/**
* Adds a Subcode to the end of the sequence of Subcodes contained by this
- * SOAPFault. Subcodes, which were introduced in SOAP 1.2, are
+ * {@code SOAPFault}. Subcodes, which were introduced in SOAP 1.2, are
* represented by a recursive sequence of subelements rooted in the
* mandatory Code subelement of a SOAP Fault.
*
@@ -194,83 +194,83 @@
public void appendFaultSubcode(QName subcode) throws SOAPException;
/**
- * Gets the fault code for this SOAPFault object.
+ * Gets the fault code for this {@code SOAPFault} object.
*
- * @return a String with the fault code
+ * @return a {@code String} with the fault code
* @see #getFaultCodeAsName
* @see #setFaultCode
*/
public String getFaultCode();
/**
- * Sets this SOAPFault object with the given fault actor.
+ * Sets this {@code SOAPFault} object with the given fault actor.
*
* The fault actor is the recipient in the message path who caused the * fault to happen. *
- * If this SOAPFault supports SOAP 1.2 then this call is
+ * If this {@code SOAPFault} supports SOAP 1.2 then this call is
* equivalent to {@link #setFaultRole(String)}
*
- * @param faultActor a String identifying the actor that
- * caused this SOAPFault object
+ * @param faultActor a {@code String} identifying the actor that
+ * caused this {@code SOAPFault} object
* @see #getFaultActor
*
* @exception SOAPException if there was an error in adding the
- * faultActor to the underlying XML tree.
+ * {@code faultActor} to the underlying XML tree.
*/
public void setFaultActor(String faultActor) throws SOAPException;
/**
- * Gets the fault actor for this SOAPFault object.
+ * Gets the fault actor for this {@code SOAPFault} object.
*
- * If this SOAPFault supports SOAP 1.2 then this call is
+ * If this {@code SOAPFault} supports SOAP 1.2 then this call is
* equivalent to {@link #getFaultRole()}
*
- * @return a String giving the actor in the message path
- * that caused this SOAPFault object
+ * @return a {@code String} giving the actor in the message path
+ * that caused this {@code SOAPFault} object
* @see #setFaultActor
*/
public String getFaultActor();
/**
- * Sets the fault string for this SOAPFault object
+ * Sets the fault string for this {@code SOAPFault} object
* to the given string.
*
* If this
- * SOAPFault is part of a message that supports SOAP 1.2 then
+ * {@code SOAPFault} is part of a message that supports SOAP 1.2 then
* this call is equivalent to:
- *
+ * {@code
* addFaultReasonText(faultString, Locale.getDefault());
- *
+ * }
*
- * @param faultString a String giving an explanation of
+ * @param faultString a {@code String} giving an explanation of
* the fault
* @see #getFaultString
*
* @exception SOAPException if there was an error in adding the
- * faultString to the underlying XML tree.
+ * {@code faultString} to the underlying XML tree.
*/
public void setFaultString(String faultString) throws SOAPException;
/**
- * Sets the fault string for this SOAPFault object
+ * Sets the fault string for this {@code SOAPFault} object
* to the given string and localized to the given locale.
*
* If this
- * SOAPFault is part of a message that supports SOAP 1.2 then
+ * {@code SOAPFault} is part of a message that supports SOAP 1.2 then
* this call is equivalent to:
- *
+ * {@code
* addFaultReasonText(faultString, locale);
- *
+ * }
*
- * @param faultString a String giving an explanation of
+ * @param faultString a {@code String} giving an explanation of
* the fault
* @param locale a {@link java.util.Locale Locale} object indicating
- * the native language of the faultString
+ * the native language of the {@code faultString}
* @see #getFaultString
*
* @exception SOAPException if there was an error in adding the
- * faultString to the underlying XML tree.
+ * {@code faultString} to the underlying XML tree.
*
* @since 1.6, SAAJ 1.2
*/
@@ -278,20 +278,20 @@
throws SOAPException;
/**
- * Gets the fault string for this SOAPFault object.
+ * Gets the fault string for this {@code SOAPFault} object.
*
* If this
- * SOAPFault is part of a message that supports SOAP 1.2 then
+ * {@code SOAPFault} is part of a message that supports SOAP 1.2 then
* this call is equivalent to:
- *
+ * {@code
* String reason = null;
* try {
* reason = (String) getFaultReasonTexts().next();
* } catch (SOAPException e) {}
* return reason;
- *
+ * }
*
- * @return a String giving an explanation of
+ * @return a {@code String} giving an explanation of
* the fault
* @see #setFaultString(String)
* @see #setFaultString(String, Locale)
@@ -299,22 +299,22 @@
public String getFaultString();
/**
- * Gets the locale of the fault string for this SOAPFault
+ * Gets the locale of the fault string for this {@code SOAPFault}
* object.
*
* If this
- * SOAPFault is part of a message that supports SOAP 1.2 then
+ * {@code SOAPFault} is part of a message that supports SOAP 1.2 then
* this call is equivalent to:
- *
+ * {@code
* Locale locale = null;
* try {
* locale = (Locale) getFaultReasonLocales().next();
* } catch (SOAPException e) {}
* return locale;
- *
+ * }
*
- * @return a Locale object indicating the native language of
- * the fault string or null if no locale was specified
+ * @return a {@code Locale} object indicating the native language of
+ * the fault string or {@code null} if no locale was specified
* @see #setFaultString(String, Locale)
*
* @since 1.6, SAAJ 1.2
@@ -322,11 +322,11 @@
public Locale getFaultStringLocale();
/**
- * Returns true if this SOAPFault has a Detail
+ * Returns true if this {@code SOAPFault} has a {@code Detail}
* subelement and false otherwise. Equivalent to
- * (getDetail()!=null).
+ * {@code (getDetail()!=null)}.
*
- * @return true if this SOAPFault has a Detail
+ * @return true if this {@code SOAPFault} has a {@code Detail}
* subelement and false otherwise.
*
* @since 1.6, SAAJ 1.3
@@ -334,44 +334,44 @@
public boolean hasDetail();
/**
- * Returns the optional detail element for this SOAPFault
+ * Returns the optional detail element for this {@code SOAPFault}
* object.
*
- * A Detail object carries application-specific error
+ * A {@code Detail} object carries application-specific error
* information, the scope of the error information is restricted to
- * faults in the SOAPBodyElement objects if this is a
+ * faults in the {@code SOAPBodyElement} objects if this is a
* SOAP 1.1 Fault.
*
- * @return a Detail object with application-specific
+ * @return a {@code Detail} object with application-specific
* error information if present, null otherwise
*/
public Detail getDetail();
/**
- * Creates an optional Detail object and sets it as the
- * Detail object for this SOAPFault
+ * Creates an optional {@code Detail} object and sets it as the
+ * {@code Detail} object for this {@code SOAPFault}
* object.
*
* It is illegal to add a detail when the fault already
* contains a detail. Therefore, this method should be called
* only after the existing detail has been removed.
*
- * @return the new Detail object
+ * @return the new {@code Detail} object
*
* @exception SOAPException if this
- * SOAPFault object already contains a
- * valid Detail object
+ * {@code SOAPFault} object already contains a
+ * valid {@code Detail} object
*/
public Detail addDetail() throws SOAPException;
/**
- * Returns an Iterator over a distinct sequence of
- * Locales for which there are associated Reason Text items.
- * Any of these Locales can be used in a call to
- * getFaultReasonText in order to obtain a localized version
+ * Returns an {@code Iterator} over a distinct sequence of
+ * {@code Locale}s for which there are associated Reason Text items.
+ * Any of these {@code Locale}s can be used in a call to
+ * {@code getFaultReasonText} in order to obtain a localized version
* of the Reason Text string.
*
- * @return an Iterator over a sequence of Locale
+ * @return an {@code Iterator} over a sequence of {@code Locale}
* objects for which there are associated Reason Text items.
*
* @exception SOAPException if there was an error in retrieving
@@ -384,11 +384,11 @@
public Iterator getFaultReasonLocales() throws SOAPException;
/**
- * Returns an Iterator over a sequence of
- * String objects containing all of the Reason Text items for
- * this SOAPFault.
+ * Returns an {@code Iterator} over a sequence of
+ * {@code String} objects containing all of the Reason Text items for
+ * this {@code SOAPFault}.
*
- * @return an Iterator over env:Fault/env:Reason/env:Text items.
+ * @return an {@code Iterator} over env:Fault/env:Reason/env:Text items.
*
* @exception SOAPException if there was an error in retrieving
* the fault Reason texts.
@@ -400,14 +400,14 @@
public Iterator getFaultReasonTexts() throws SOAPException;
/**
- * Returns the Reason Text associated with the given Locale.
+ * Returns the Reason Text associated with the given {@code Locale}.
* If more than one such Reason Text exists the first matching Text is
* returned
*
- * @param locale -- the Locale for which a localized
+ * @param locale -- the {@code Locale} for which a localized
* Reason Text is desired
*
- * @return the Reason Text associated with locale
+ * @return the Reason Text associated with {@code locale}
*
* @see #getFaultString
*
@@ -423,23 +423,23 @@
/**
* Appends or replaces a Reason Text item containing the specified
* text message and an xml:lang derived from
- * locale. If a Reason Text item with this
+ * {@code locale}. If a Reason Text item with this
* xml:lang already exists its text value will be replaced
- * with text.
- * The locale parameter should not be null
+ * with {@code text}.
+ * The {@code locale} parameter should not be {@code null}
*
* Code sample: * - *
+ * {@code
* SOAPFault fault = ...;
* fault.addFaultReasonText("Version Mismatch", Locale.ENGLISH);
- *
+ * }
*
* @param text -- reason message string
* @param locale -- Locale object representing the locale of the message
*
* @exception SOAPException if there was an error in adding the Reason text
- * or the locale passed was null.
+ * or the {@code locale} passed was {@code null}.
* @exception UnsupportedOperationException if this message does not
* support the SOAP 1.2 concept of Fault Reason.
*
@@ -450,11 +450,11 @@
/**
* Returns the optional Node element value for this
- * SOAPFault object. The Node element is
+ * {@code SOAPFault} object. The Node element is
* optional in SOAP 1.2.
*
* @return Content of the env:Fault/env:Node element as a String
- * or null if none
+ * or {@code null} if none
*
* @exception UnsupportedOperationException if this message does not
* support the SOAP 1.2 concept of Fault Node.
@@ -465,11 +465,11 @@
/**
* Creates or replaces any existing Node element value for
- * this SOAPFault object. The Node element
+ * this {@code SOAPFault} object. The Node element
* is optional in SOAP 1.2.
*
* @exception SOAPException if there was an error in setting the
- * Node for this SOAPFault object.
+ * Node for this {@code SOAPFault} object.
* @exception UnsupportedOperationException if this message does not
* support the SOAP 1.2 concept of Fault Node.
*
@@ -480,11 +480,11 @@
/**
* Returns the optional Role element value for this
- * SOAPFault object. The Role element is
+ * {@code SOAPFault} object. The Role element is
* optional in SOAP 1.2.
*
* @return Content of the env:Fault/env:Role element as a String
- * or null if none
+ * or {@code null} if none
*
* @exception UnsupportedOperationException if this message does not
* support the SOAP 1.2 concept of Fault Role.
@@ -495,13 +495,13 @@
/**
* Creates or replaces any existing Role element value for
- * this SOAPFault object. The Role element
+ * this {@code SOAPFault} object. The Role element
* is optional in SOAP 1.2.
*
* @param uri - the URI of the Role
*
* @exception SOAPException if there was an error in setting the
- * Role for this SOAPFault object.
+ * Role for this {@code SOAPFault} object.
*
* @exception UnsupportedOperationException if this message does not
* support the SOAP 1.2 concept of Fault Role.
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/soap/SOAPFaultElement.java
--- a/src/java.xml.ws/share/classes/javax/xml/soap/SOAPFaultElement.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/soap/SOAPFaultElement.java Thu Jul 16 19:27:53 2015 -0700
@@ -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
@@ -27,11 +27,11 @@
/**
* A representation of the contents in
- * a SOAPFault object. The Detail interface
- * is a SOAPFaultElement.
+ * a {@code SOAPFault} object. The {@code Detail} interface
+ * is a {@code SOAPFaultElement}.
*
- * Content is added to a SOAPFaultElement using the
- * SOAPElement method addTextNode.
+ * Content is added to a {@code SOAPFaultElement} using the
+ * {@code SOAPElement} method {@code addTextNode}.
*
* @since 1.6
*/
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/soap/SOAPHeader.java
--- a/src/java.xml.ws/share/classes/javax/xml/soap/SOAPHeader.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/soap/SOAPHeader.java Thu Jul 16 19:27:53 2015 -0700
@@ -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
@@ -34,49 +34,49 @@
* element. A SOAP header element consists of XML data that affects
* the way the application-specific content is processed by the message
* provider. For example, transaction semantics, authentication information,
- * and so on, can be specified as the content of a SOAPHeader
+ * and so on, can be specified as the content of a {@code SOAPHeader}
* object.
*
- * A SOAPEnvelope object contains an empty
- * SOAPHeader object by default. If the SOAPHeader
+ * A {@code SOAPEnvelope} object contains an empty
+ * {@code SOAPHeader} object by default. If the {@code SOAPHeader}
* object, which is optional, is not needed, it can be retrieved and deleted
* with the following line of code. The variable se is a
- * SOAPEnvelope object.
- *
+ * {@code SOAPEnvelope} object.
+ * {@code
* se.getHeader().detachNode();
- *
+ * }
*
- * A SOAPHeader object is created with the SOAPEnvelope
- * method addHeader. This method, which creates a new header and adds it
+ * A {@code SOAPHeader} object is created with the {@code SOAPEnvelope}
+ * method {@code addHeader}. This method, which creates a new header and adds it
* to the envelope, may be called only after the existing header has been removed.
*
- *
+ * {@code
* se.getHeader().detachNode();
* SOAPHeader sh = se.addHeader();
- *
+ * }
*
- * A SOAPHeader object can have only SOAPHeaderElement
- * objects as its immediate children. The method addHeaderElement
- * creates a new HeaderElement object and adds it to the
- * SOAPHeader object. In the following line of code, the
- * argument to the method addHeaderElement is a Name
- * object that is the name for the new HeaderElement object.
- *
+ * A {@code SOAPHeader} object can have only {@code SOAPHeaderElement}
+ * objects as its immediate children. The method {@code addHeaderElement}
+ * creates a new {@code HeaderElement} object and adds it to the
+ * {@code SOAPHeader} object. In the following line of code, the
+ * argument to the method {@code addHeaderElement} is a {@code Name}
+ * object that is the name for the new {@code HeaderElement} object.
+ * {@code
* SOAPHeaderElement shElement = sh.addHeaderElement(name);
- *
+ * }
*
* @see SOAPHeaderElement
* @since 1.6
*/
public interface SOAPHeader extends SOAPElement {
/**
- * Creates a new SOAPHeaderElement object initialized with the
- * specified name and adds it to this SOAPHeader object.
+ * Creates a new {@code SOAPHeaderElement} object initialized with the
+ * specified name and adds it to this {@code SOAPHeader} object.
*
- * @param name a Name object with the name of the new
- * SOAPHeaderElement object
- * @return the new SOAPHeaderElement object that was
- * inserted into this SOAPHeader object
+ * @param name a {@code Name} object with the name of the new
+ * {@code SOAPHeaderElement} object
+ * @return the new {@code SOAPHeaderElement} object that was
+ * inserted into this {@code SOAPHeader} object
* @exception SOAPException if a SOAP error occurs
* @see SOAPHeader#addHeaderElement(javax.xml.namespace.QName)
*/
@@ -84,13 +84,13 @@
throws SOAPException;
/**
- * Creates a new SOAPHeaderElement object initialized with the
- * specified qname and adds it to this SOAPHeader object.
+ * Creates a new {@code SOAPHeaderElement} object initialized with the
+ * specified qname and adds it to this {@code SOAPHeader} object.
*
- * @param qname a QName object with the qname of the new
- * SOAPHeaderElement object
- * @return the new SOAPHeaderElement object that was
- * inserted into this SOAPHeader object
+ * @param qname a {@code QName} object with the qname of the new
+ * {@code SOAPHeaderElement} object
+ * @return the new {@code SOAPHeaderElement} object that was
+ * inserted into this {@code SOAPHeader} object
* @exception SOAPException if a SOAP error occurs
* @see SOAPHeader#addHeaderElement(Name)
* @since 1.6, SAAJ 1.3
@@ -99,19 +99,19 @@
throws SOAPException;
/**
- * Returns an Iterator over all the SOAPHeaderElement objects
- * in this SOAPHeader object
+ * Returns an {@code Iterator} over all the {@code SOAPHeaderElement} objects
+ * in this {@code SOAPHeader} object
* that have the specified actor and that have a MustUnderstand attribute
- * whose value is equivalent to true.
+ * whose value is equivalent to {@code true}.
*
* In SOAP 1.2 the env:actor attribute is replaced by the env:role
* attribute, but with essentially the same semantics.
*
- * @param actor a String giving the URI of the actor / role
+ * @param actor a {@code String} giving the URI of the {@code actor} / {@code role}
* for which to search
- * @return an Iterator object over all the
- * SOAPHeaderElement objects that contain the specified
- * actor / role and are marked as MustUnderstand
+ * @return an {@code Iterator} object over all the
+ * {@code SOAPHeaderElement} objects that contain the specified
+ * {@code actor} / {@code role} and are marked as MustUnderstand
* @see #examineHeaderElements
* @see #extractHeaderElements
* @see SOAPConstants#URI_SOAP_ACTOR_NEXT
@@ -121,8 +121,8 @@
public Iterator examineMustUnderstandHeaderElements(String actor);
/**
- * Returns an Iterator over all the SOAPHeaderElement objects
- * in this SOAPHeader object
+ * Returns an {@code Iterator} over all the {@code SOAPHeaderElement} objects
+ * in this {@code SOAPHeader} object
* that have the specified actor.
*
* An actor is a global attribute that indicates the intermediate
@@ -130,40 +130,40 @@
* receiver. An actor receives the message and processes it before sending
* it on to the next actor. The default actor is the ultimate intended
* recipient for the message, so if no actor attribute is included in a
- * SOAPHeader object, it is sent to the ultimate receiver
+ * {@code SOAPHeader} object, it is sent to the ultimate receiver
* along with the message body.
*
* In SOAP 1.2 the env:actor attribute is replaced by the env:role
* attribute, but with essentially the same semantics.
*
- * @param actor a String giving the URI of the actor / role
+ * @param actor a {@code String} giving the URI of the {@code actor} / {@code role}
* for which to search
- * @return an Iterator object over all the
- * SOAPHeaderElement objects that contain the specified
- * actor / role
+ * @return an {@code Iterator} object over all the
+ * {@code SOAPHeaderElement} objects that contain the specified
+ * {@code actor} / {@code role}
* @see #extractHeaderElements
* @see SOAPConstants#URI_SOAP_ACTOR_NEXT
*/
public Iterator examineHeaderElements(String actor);
/**
- * Returns an Iterator over all the SOAPHeaderElement objects
- * in this SOAPHeader object
+ * Returns an {@code Iterator} over all the {@code SOAPHeaderElement} objects
+ * in this {@code SOAPHeader} object
* that have the specified actor and detaches them
- * from this SOAPHeader object.
+ * from this {@code SOAPHeader} object.
*
* This method allows an actor to process the parts of the
- * SOAPHeader object that apply to it and to remove
+ * {@code SOAPHeader} object that apply to it and to remove
* them before passing the message on to the next actor.
*
* In SOAP 1.2 the env:actor attribute is replaced by the env:role
* attribute, but with essentially the same semantics.
*
- * @param actor a String giving the URI of the actor / role
+ * @param actor a {@code String} giving the URI of the {@code actor} / {@code role}
* for which to search
- * @return an Iterator object over all the
- * SOAPHeaderElement objects that contain the specified
- * actor / role
+ * @return an {@code Iterator} object over all the
+ * {@code SOAPHeaderElement} objects that contain the specified
+ * {@code actor} / {@code role}
*
* @see #examineHeaderElements
* @see SOAPConstants#URI_SOAP_ACTOR_NEXT
@@ -171,14 +171,14 @@
public Iterator extractHeaderElements(String actor);
/**
- * Creates a new NotUnderstood SOAPHeaderElement object initialized
- * with the specified name and adds it to this SOAPHeader object.
+ * Creates a new NotUnderstood {@code SOAPHeaderElement} object initialized
+ * with the specified name and adds it to this {@code SOAPHeader} object.
* This operation is supported only by SOAP 1.2.
*
- * @param name a QName object with the name of the
- * SOAPHeaderElement object that was not understood.
- * @return the new SOAPHeaderElement object that was
- * inserted into this SOAPHeader object
+ * @param name a {@code QName} object with the name of the
+ * {@code SOAPHeaderElement} object that was not understood.
+ * @return the new {@code SOAPHeaderElement} object that was
+ * inserted into this {@code SOAPHeader} object
* @exception SOAPException if a SOAP error occurs.
* @exception UnsupportedOperationException if this is a SOAP 1.1 Header.
* @since 1.6, SAAJ 1.3
@@ -187,15 +187,15 @@
throws SOAPException;
/**
- * Creates a new Upgrade SOAPHeaderElement object initialized
+ * Creates a new Upgrade {@code SOAPHeaderElement} object initialized
* with the specified List of supported SOAP URIs and adds it to this
- * SOAPHeader object.
+ * {@code SOAPHeader} object.
* This operation is supported on both SOAP 1.1 and SOAP 1.2 header.
*
- * @param supportedSOAPURIs an Iterator object with the URIs of SOAP
+ * @param supportedSOAPURIs an {@code Iterator} object with the URIs of SOAP
* versions supported.
- * @return the new SOAPHeaderElement object that was
- * inserted into this SOAPHeader object
+ * @return the new {@code SOAPHeaderElement} object that was
+ * inserted into this {@code SOAPHeader} object
* @exception SOAPException if a SOAP error occurs.
* @since 1.6, SAAJ 1.3
*/
@@ -203,14 +203,14 @@
throws SOAPException;
/**
- * Creates a new Upgrade SOAPHeaderElement object initialized
+ * Creates a new Upgrade {@code SOAPHeaderElement} object initialized
* with the specified array of supported SOAP URIs and adds it to this
- * SOAPHeader object.
+ * {@code SOAPHeader} object.
* This operation is supported on both SOAP 1.1 and SOAP 1.2 header.
*
* @param supportedSoapUris an array of the URIs of SOAP versions supported.
- * @return the new SOAPHeaderElement object that was
- * inserted into this SOAPHeader object
+ * @return the new {@code SOAPHeaderElement} object that was
+ * inserted into this {@code SOAPHeader} object
* @exception SOAPException if a SOAP error occurs.
* @since 1.6, SAAJ 1.3
*/
@@ -218,14 +218,14 @@
throws SOAPException;
/**
- * Creates a new Upgrade SOAPHeaderElement object initialized
+ * Creates a new Upgrade {@code SOAPHeaderElement} object initialized
* with the specified supported SOAP URI and adds it to this
- * SOAPHeader object.
+ * {@code SOAPHeader} object.
* This operation is supported on both SOAP 1.1 and SOAP 1.2 header.
*
* @param supportedSoapUri the URI of SOAP the version that is supported.
- * @return the new SOAPHeaderElement object that was
- * inserted into this SOAPHeader object
+ * @return the new {@code SOAPHeaderElement} object that was
+ * inserted into this {@code SOAPHeader} object
* @exception SOAPException if a SOAP error occurs.
* @since 1.6, SAAJ 1.3
*/
@@ -233,12 +233,12 @@
throws SOAPException;
/**
- * Returns an Iterator over all the SOAPHeaderElement objects
- * in this SOAPHeader object.
+ * Returns an {@code Iterator} over all the {@code SOAPHeaderElement} objects
+ * in this {@code SOAPHeader} object.
*
- * @return an Iterator object over all the
- * SOAPHeaderElement objects contained by this
- * SOAPHeader
+ * @return an {@code Iterator} object over all the
+ * {@code SOAPHeaderElement} objects contained by this
+ * {@code SOAPHeader}
* @see #extractAllHeaderElements
*
* @since 1.6, SAAJ 1.2
@@ -246,13 +246,13 @@
public Iterator examineAllHeaderElements();
/**
- * Returns an Iterator over all the SOAPHeaderElement objects
- * in this SOAPHeader object and detaches them
- * from this SOAPHeader object.
+ * Returns an {@code Iterator} over all the {@code SOAPHeaderElement} objects
+ * in this {@code SOAPHeader} object and detaches them
+ * from this {@code SOAPHeader} object.
*
- * @return an Iterator object over all the
- * SOAPHeaderElement objects contained by this
- * SOAPHeader
+ * @return an {@code Iterator} object over all the
+ * {@code SOAPHeaderElement} objects contained by this
+ * {@code SOAPHeader}
*
* @see #examineAllHeaderElements
*
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/soap/SOAPHeaderElement.java
--- a/src/java.xml.ws/share/classes/javax/xml/soap/SOAPHeaderElement.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/soap/SOAPHeaderElement.java Thu Jul 16 19:27:53 2015 -0700
@@ -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,25 +28,25 @@
/**
* An object representing the contents in the SOAP header part of the
* SOAP envelope.
- * The immediate children of a SOAPHeader object can
- * be represented only as SOAPHeaderElement objects.
+ * The immediate children of a {@code SOAPHeader} object can
+ * be represented only as {@code SOAPHeaderElement} objects.
*
- * A SOAPHeaderElement object can have other
- * SOAPElement objects as its children.
+ * A {@code SOAPHeaderElement} object can have other
+ * {@code SOAPElement} objects as its children.
*
* @since 1.6
*/
public interface SOAPHeaderElement extends SOAPElement {
/**
- * Sets the actor associated with this SOAPHeaderElement
+ * Sets the actor associated with this {@code SOAPHeaderElement}
* object to the specified actor. The default value of an actor is:
- * SOAPConstants.URI_SOAP_ACTOR_NEXT
+ * {@code SOAPConstants.URI_SOAP_ACTOR_NEXT}
*
- * If this SOAPHeaderElement supports SOAP 1.2 then this call is
+ * If this {@code SOAPHeaderElement} supports SOAP 1.2 then this call is
* equivalent to {@link #setRole(String)}
*
- * @param actorURI a String giving the URI of the actor
+ * @param actorURI a {@code String} giving the URI of the actor
* to set
*
* @exception IllegalArgumentException if there is a problem in
@@ -57,10 +57,10 @@
public void setActor(String actorURI);
/**
- * Sets the Role associated with this SOAPHeaderElement
- * object to the specified Role.
+ * Sets the {@code Role} associated with this {@code SOAPHeaderElement}
+ * object to the specified {@code Role}.
*
- * @param uri - the URI of the Role
+ * @param uri - the URI of the {@code Role}
*
* @throws SOAPException if there is an error in setting the role
*
@@ -73,20 +73,20 @@
/**
* Returns the uri of the actor attribute of this
- * SOAPHeaderElement.
+ * {@code SOAPHeaderElement}.
*
- * If this SOAPHeaderElement supports SOAP 1.2 then this call is
+ * If this {@code SOAPHeaderElement} supports SOAP 1.2 then this call is
* equivalent to {@link #getRole()}
- * @return a String giving the URI of the actor
+ * @return a {@code String} giving the URI of the actor
* @see #setActor
*/
public String getActor();
/**
* Returns the value of the Role attribute of this
- * SOAPHeaderElement.
+ * {@code SOAPHeaderElement}.
*
- * @return a String giving the URI of the Role
+ * @return a {@code String} giving the URI of the {@code Role}
*
* @exception UnsupportedOperationException if this message does not
* support the SOAP 1.2 concept of Fault Role.
@@ -96,16 +96,16 @@
public String getRole();
/**
- * Sets the mustUnderstand attribute for this SOAPHeaderElement
+ * Sets the mustUnderstand attribute for this {@code SOAPHeaderElement}
* object to be either true or false.
*
* If the mustUnderstand attribute is on, the actor who receives the
- * SOAPHeaderElement must process it correctly. This
- * ensures, for example, that if the SOAPHeaderElement
+ * {@code SOAPHeaderElement} must process it correctly. This
+ * ensures, for example, that if the {@code SOAPHeaderElement}
* object modifies the message, that the message is being modified correctly.
*
- * @param mustUnderstand true to set the mustUnderstand
- * attribute to true; false to set it to false
+ * @param mustUnderstand {@code true} to set the mustUnderstand
+ * attribute to true; {@code false} to set it to false
*
* @exception IllegalArgumentException if there is a problem in
* setting the mustUnderstand attribute
@@ -116,16 +116,16 @@
/**
* Returns the boolean value of the mustUnderstand attribute for this
- * SOAPHeaderElement.
+ * {@code SOAPHeaderElement}.
*
- * @return true if the mustUnderstand attribute of this
- * SOAPHeaderElement object is turned on; false
+ * @return {@code true} if the mustUnderstand attribute of this
+ * {@code SOAPHeaderElement} object is turned on; {@code false}
* otherwise
*/
public boolean getMustUnderstand();
/**
- * Sets the relay attribute for this SOAPHeaderElement to be
+ * Sets the relay attribute for this {@code SOAPHeaderElement} to be
* either true or false.
*
* The SOAP relay attribute is set to true to indicate that the SOAP header
@@ -133,7 +133,7 @@
* but not actually process it. This attribute is ignored on header blocks
* whose mustUnderstand attribute is set to true or that are targeted at
* the ultimate reciever (which is the default). The default value of this
- * attribute is false.
+ * attribute is {@code false}.
*
* @param relay the new value of the relay attribute
*
@@ -151,10 +151,10 @@
/**
* Returns the boolean value of the relay attribute for this
- * SOAPHeaderElement
+ * {@code SOAPHeaderElement}
*
- * @return true if the relay attribute is turned on;
- * false otherwise
+ * @return {@code true} if the relay attribute is turned on;
+ * {@code false} otherwise
*
* @exception UnsupportedOperationException if this message does not
* support the SOAP 1.2 concept of Relay attribute.
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/soap/SOAPMessage.java
--- a/src/java.xml.ws/share/classes/javax/xml/soap/SOAPMessage.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/soap/SOAPMessage.java Thu Jul 16 19:27:53 2015 -0700
@@ -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
@@ -55,12 +55,12 @@
* object, and the {@code SOAPEnvelope} object is used to retrieve the
* {@code SOAPBody} and {@code SOAPHeader} objects.
*
- *
+ * {@code
* SOAPPart sp = message.getSOAPPart();
* SOAPEnvelope se = sp.getEnvelope();
* SOAPBody sb = se.getBody();
* SOAPHeader sh = se.getHeader();
- *
+ * }
*
* * In addition to the mandatory {@code SOAPPart} object, a {@code SOAPMessage} @@ -103,14 +103,15 @@ * @since 1.6 */ public abstract class SOAPMessage { + /** - * Specifies the character type encoding for the SOAP Message. Valid values - * include "utf-8" and "utf-16". See vendor documentation for additional - * supported values. The default is "utf-8". - * - * @see SOAPMessage#setProperty(String, Object) SOAPMessage.setProperty - * @since 1.6, SAAJ 1.2 - */ + * Specifies the character type encoding for the SOAP Message. Valid values + * include "utf-8" and "utf-16". See vendor documentation for additional + * supported values. The default is "utf-8". + * + * @see SOAPMessage#setProperty(String, Object) SOAPMessage.setProperty + * @since 1.6, SAAJ 1.2 + */ public static final String CHARACTER_SET_ENCODING = "javax.xml.soap.character-set-encoding"; @@ -146,25 +147,24 @@ public abstract String getContentDescription(); /** - * Gets the SOAP part of this {@code SOAPMessage} object. - *
- * {@code SOAPMessage} object contains one or more attachments, the - * SOAP Part must be the first MIME body part in the message. - * - * @return the {@code SOAPPart} object for this {@code SOAPMessage} - * object - */ + * Gets the SOAP part of this {@code SOAPMessage} object. + *
+ * {@code SOAPMessage} object contains one or more attachments, the + * SOAP Part must be the first MIME body part in the message. + * + * @return the {@code SOAPPart} object for this {@code SOAPMessage} + * object + */ public abstract SOAPPart getSOAPPart(); /** - * Gets the SOAP Body contained in this {@code SOAPMessage} object. - * - * @return the {@code SOAPBody} object contained by this {@code SOAPMessage} - * object - * @exception SOAPException - * if the SOAP Body does not exist or cannot be retrieved - * @since 1.6, SAAJ 1.2 - */ + * Gets the SOAP Body contained in this {@code SOAPMessage} object. + * + * @return the {@code SOAPBody} object contained by this {@code SOAPMessage} + * object + * @throws SOAPException if the SOAP Body does not exist or cannot be retrieved + * @since 1.6, SAAJ 1.2 + */ public SOAPBody getSOAPBody() throws SOAPException { throw new UnsupportedOperationException("getSOAPBody must be overridden by all subclasses of SOAPMessage"); } @@ -183,41 +183,40 @@ } /** - * Removes all {@code AttachmentPart} objects that have been added - * to this {@code SOAPMessage} object. - *
- * This method does not touch the SOAP part. - */ + * Removes all {@code AttachmentPart} objects that have been added + * to this {@code SOAPMessage} object. + *
+ * This method does not touch the SOAP part. + */ public abstract void removeAllAttachments(); /** - * Gets a count of the number of attachments in this message. This count - * does not include the SOAP part. - * - * @return the number of {@code AttachmentPart} objects that are - * part of this {@code SOAPMessage} object - */ + * Gets a count of the number of attachments in this message. This count + * does not include the SOAP part. + * + * @return the number of {@code AttachmentPart} objects that are + * part of this {@code SOAPMessage} object + */ public abstract int countAttachments(); /** - * Retrieves all the {@code AttachmentPart} objects that are part of - * this {@code SOAPMessage} object. - * - * @return an iterator over all the attachments in this message - */ + * Retrieves all the {@code AttachmentPart} objects that are part of + * this {@code SOAPMessage} object. + * + * @return an iterator over all the attachments in this message + */ public abstract Iterator getAttachments(); /** - * Retrieves all the {@code AttachmentPart} objects that have header - * entries that match the specified headers. Note that a returned - * attachment could have headers in addition to those specified. - * - * @param headers - * a {@code MimeHeaders} object containing the MIME - * headers for which to search - * @return an iterator over all attachments that have a header that matches - * one of the given headers - */ + * Retrieves all the {@code AttachmentPart} objects that have header + * entries that match the specified headers. Note that a returned + * attachment could have headers in addition to those specified. + * + * @param headers a {@code MimeHeaders} object containing the MIME + * headers for which to search + * @return an iterator over all attachments that have a header that matches + * one of the given headers + */ public abstract Iterator getAttachments(MimeHeaders headers); /** diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/soap/SOAPPart.java --- a/src/java.xml.ws/share/classes/javax/xml/soap/SOAPPart.java Thu Jul 16 13:51:53 2015 -0700 +++ b/src/java.xml.ws/share/classes/javax/xml/soap/SOAPPart.java Thu Jul 16 19:27:53 2015 -0700 @@ -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 @@ -54,9 +54,9 @@ * calling the method {@code SOAPMessage.getSOAPPart}. The * following line of code, in which {@code message} is a * {@code SOAPMessage} object, retrieves the SOAP part of a message. - *
+ * {@code
* SOAPPart soapPart = message.getSOAPPart();
- *
+ * }
*
* A {@code SOAPPart} object contains a {@code SOAPEnvelope} object,
* which in turn contains a {@code SOAPBody} object and a
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/soap/Text.java
--- a/src/java.xml.ws/share/classes/javax/xml/soap/Text.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/soap/Text.java Thu Jul 16 19:27:53 2015 -0700
@@ -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
@@ -26,7 +26,7 @@
package javax.xml.soap;
/**
- * A representation of a node whose value is text. A Text object
+ * A representation of a node whose value is text. A {@code Text} object
* may represent text that is content or text that is a comment.
*
* @since 1.6
@@ -34,10 +34,10 @@
public interface Text extends Node, org.w3c.dom.Text {
/**
- * Retrieves whether this Text object represents a comment.
+ * Retrieves whether this {@code Text} object represents a comment.
*
- * @return true if this Text object is a
- * comment; false otherwise
+ * @return {@code true} if this {@code Text} object is a
+ * comment; {@code false} otherwise
*/
public boolean isComment();
}
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/ws/AsyncHandler.java
--- a/src/java.xml.ws/share/classes/javax/xml/ws/AsyncHandler.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/ws/AsyncHandler.java Thu Jul 16 19:27:53 2015 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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
@@ -25,7 +25,7 @@
package javax.xml.ws;
-/** The AsyncHandler interface is implemented by
+/** The {@code AsyncHandler} interface is implemented by
* clients that wish to receive callback notification of the completion of
* service endpoint operations invoked asynchronously.
*
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/ws/BindingProvider.java
--- a/src/java.xml.ws/share/classes/javax/xml/ws/BindingProvider.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/ws/BindingProvider.java Thu Jul 16 19:27:53 2015 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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
@@ -29,7 +29,7 @@
import javax.xml.ws.wsaddressing.W3CEndpointReference;
/**
- * The BindingProvider interface provides access to the
+ * The {@code BindingProvider} interface provides access to the
* protocol binding and associated context objects for request and
* response message processing.
*
@@ -40,14 +40,14 @@
public interface BindingProvider {
/**
* Standard property: User name for authentication.
- *
Type: java.lang.String
+ *
Type: {@code java.lang.String} **/ public static final String USERNAME_PROPERTY = "javax.xml.ws.security.auth.username"; /** * Standard property: Password for authentication. - *
Type: java.lang.String
+ *
Type: {@code java.lang.String} **/ public static final String PASSWORD_PROPERTY = "javax.xml.ws.security.auth.password"; @@ -57,7 +57,7 @@ * URI scheme for the endpoint address specification MUST * correspond to the protocol/transport binding for the * binding in use. - *
Type: java.lang.String
+ *
Type: {@code java.lang.String}
**/
public static final String ENDPOINT_ADDRESS_PROPERTY =
"javax.xml.ws.service.endpoint.address";
@@ -66,10 +66,10 @@
* Standard property: This boolean property is used by a service
* client to indicate whether or not it wants to participate in
* a session with a service endpoint. If this property is set to
- * true, the service client indicates that it wants the session
- * to be maintained. If set to false, the session is not maintained.
- * The default value for this property is false.
- *
Type: java.lang.Boolean
+ * {@code true}, the service client indicates that it wants the session
+ * to be maintained. If set to {@code false}, the session is not maintained.
+ * The default value for this property is {@code false}.
+ *
Type: {@code java.lang.Boolean}
**/
public static final String SESSION_MAINTAIN_PROPERTY =
"javax.xml.ws.session.maintain";
@@ -77,29 +77,29 @@
/**
* Standard property for SOAPAction. This boolean property
* indicates whether or not the value of the
- * javax.xml.ws.soap.http.soapaction.uri property
+ * {@code javax.xml.ws.soap.http.soapaction.uri} property
* is used for the value of the SOAPAction. The
- * default value of this property is false indicating
+ * default value of this property is {@code false} indicating
* that the
- * javax.xml.ws.soap.http.soapaction.uri property
+ * {@code javax.xml.ws.soap.http.soapaction.uri} property
* is not used for the value of the SOAPAction, however,
* if WS-Addressing is enabled, the default value is
- * true.
+ * {@code true}.
*
- *
Type: java.lang.Boolean
+ *
Type: {@code java.lang.Boolean}
**/
public static final String SOAPACTION_USE_PROPERTY =
"javax.xml.ws.soap.http.soapaction.use";
/**
* Standard property for SOAPAction. Indicates the SOAPAction
- * URI if the javax.xml.ws.soap.http.soapaction.use
- * property is set to true. If WS-Addressing
+ * URI if the {@code javax.xml.ws.soap.http.soapaction.use}
+ * property is set to {@code true}. If WS-Addressing
* is enabled, this value will also be used for the value of the
* WS-Addressing Action header. If this property is not set,
* the default SOAPAction and WS-Addressing Action will be sent.
*
- *
Type: java.lang.String
+ *
Type: {@code java.lang.String}
**/
public static final String SOAPACTION_URI_PROPERTY =
"javax.xml.ws.soap.http.soapaction.uri";
@@ -139,18 +139,18 @@
/**
- * Returns the EndpointReference associated with
- * this BindingProvider instance.
+ * Returns the {@code EndpointReference} associated with
+ * this {@code BindingProvider} instance.
*
- * If the Binding for this bindingProvider is
+ * If the Binding for this {@code bindingProvider} is
* either SOAP1.1/HTTP or SOAP1.2/HTTP, then a
- * W3CEndpointReference MUST be returned.
+ * {@code W3CEndpointReference} MUST be returned.
*
* @return EndpointReference of the target endpoint associated with this
- * BindingProvider instance.
+ * {@code BindingProvider} instance.
*
* @throws java.lang.UnsupportedOperationException If this
- * BindingProvider uses the XML/HTTP binding.
+ * {@code BindingProvider} uses the XML/HTTP binding.
*
* @see W3CEndpointReference
*
@@ -160,21 +160,21 @@
/**
- * Returns the EndpointReference associated with
- * this BindingProvider instance. The instance
- * returned will be of type clazz.
+ * Returns the {@code EndpointReference} associated with
+ * this {@code BindingProvider} instance. The instance
+ * returned will be of type {@code clazz}.
*
- * @param clazz Specifies the type of EndpointReference
+ * @param clazz Specifies the type of {@code EndpointReference}
* that MUST be returned.
* @return EndpointReference of the target endpoint associated with this
- * BindingProvider instance. MUST be of type
- * clazz.
+ * {@code BindingProvider} instance. MUST be of type
+ * {@code clazz}.
- * @throws WebServiceException If the Class clazz
+ * @throws WebServiceException If the Class {@code clazz}
* is not supported by this implementation.
* @throws java.lang.UnsupportedOperationException If this
- * BindingProvider uses the XML/HTTP binding.
+ * {@code BindingProvider} uses the XML/HTTP binding.
*
* @since 1.6, JAX-WS 2.1
*/
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/ws/BindingType.java
--- a/src/java.xml.ws/share/classes/javax/xml/ws/BindingType.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/ws/BindingType.java Thu Jul 16 19:27:53 2015 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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
@@ -32,7 +32,7 @@
import java.lang.annotation.RetentionPolicy;
/**
- * The BindingType annotation is used to
+ * The {@code BindingType} annotation is used to
* specify the binding to use for a web service
* endpoint implementation class.
*
@@ -50,7 +50,7 @@ * A binding identifier (a URI). * If not specified, the default is the SOAP 1.1 / HTTP binding. *
- * See the SOAPBinding and HTTPBinding
+ * See the {@code SOAPBinding} and {@code HTTPBinding}
* for the definition of the standard binding identifiers.
*
* @see javax.xml.ws.Binding
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/ws/Endpoint.java
--- a/src/java.xml.ws/share/classes/javax/xml/ws/Endpoint.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/ws/Endpoint.java Thu Jul 16 19:27:53 2015 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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
@@ -37,23 +37,23 @@
* A Web service endpoint.
*
*
Endpoints are created using the static methods defined in this
- * class. An endpoint is always tied to one Binding
+ * class. An endpoint is always tied to one {@code Binding}
* and one implementor, both set at endpoint creation time.
*
*
An endpoint is either in a published or an unpublished state.
- * The publish methods can be used to start publishing
+ * The {@code publish} methods can be used to start publishing
* an endpoint, at which point it starts accepting incoming requests.
- * Conversely, the stop method can be used to stop
+ * Conversely, the {@code stop} method can be used to stop
* accepting incoming requests and take the endpoint down.
* Once stopped, an endpoint cannot be published again.
*
- *
An Executor may be set on the endpoint in order
+ *
An {@code Executor} may be set on the endpoint in order
* to gain better control over the threads used to dispatch incoming
* requests. For instance, thread pooling with certain parameters
- * can be enabled by creating a ThreadPoolExecutor and
+ * can be enabled by creating a {@code ThreadPoolExecutor} and
* registering it with the endpoint.
*
- *
Handler chains can be set using the contained Binding.
+ *
Handler chains can be set using the contained {@code Binding}. * *
An endpoint may have a list of metadata documents, such as WSDL
* and XMLSchema documents, bound to it. At publishing time, the
@@ -114,8 +114,8 @@
*
* @param implementor The endpoint implementor.
* @param features A list of WebServiceFeature to configure on the
- * endpoint. Supported features not in the
- * If the Binding for this
* Concrete implementations of this class will represent
- * an
* Web service developers that wish to pass or return
- *
* JAX-WS implementors are expected to extract the XML infoset
- * from an
* JAXB will bind this class to xs:anyType. If a better binding
@@ -92,68 +92,68 @@
/**
* Factory method to read an EndpointReference from the infoset contained in
- *
- * Because this port is not created from a If the returned If the returned {@code Source} is an instance of
+ * {@code DOMSource}, then
* modifications to the encapsulated DOM tree change the message
* payload in-place, there is no need to susequently call
- * Service endpoints may implement the Service endpoints may implement the {@code Provider}
* interface as a dynamic alternative to an SEI.
*
- * Implementations are required to support Implementations are required to support {@code Provider The The {@code ServiceMode} annotation can be used to control whether
+ * the {@code Provider} instance will receive entire protocol messages
* or just message payloads.
*
* @since 1.6, JAX-WS 2.0
@@ -50,11 +50,11 @@
* message.
*
* @param request The request message or message payload.
- * @return The response message or message payload. May be When starting from Java this annotation is used resolve
- * overloading conflicts in document literal mode. Only the
* This annotation MUST only be used in conjunction the
- *
*
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/ws/RespectBindingFeature.java
--- a/src/java.xml.ws/share/classes/javax/xml/ws/RespectBindingFeature.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/ws/RespectBindingFeature.java Thu Jul 16 19:27:53 2015 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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,7 +28,7 @@
import javax.xml.ws.soap.AddressingFeature;
/**
- * This feature clarifies the use of the
* This feature is only useful with web services that have an
* associated WSDL. Enabling this feature requires that a JAX-WS
- * implementation inspect the
* The following describes the affects of this feature with respect
* to be enabled or disabled:
* For asynchronous operation invocations it provides additional methods
- * to check the status of the request. The When starting from Java this annotation is used resolve
- * overloading conflicts in document literal mode. Only the {@code Service} acts as a factory of the following:
* The ports available on a service can be enumerated using the
- * Handler chains for all the objects created by a Handler chains for all the objects created by a {@code Service}
+ * can be set by means of a {@code HandlerResolver}.
*
- * An An {@code Executor} may be set on the service in order
* to gain better control over the threads used to dispatch asynchronous
* callbacks. For instance, thread pooling with certain parameters
- * can be enabled by creating a
* Calling this method has the same behavior as the following
*
* This method behaves the same as calling
*
* This method behavies the same as calling
*
* The handler resolver, if present, will be called once for each
* proxy or dispatch instance that is created, and the handler chain
* returned by the resolver will be set on the instance.
*
- * @param handlerResolver The The information specified in this annotation is sufficient
- * to uniquely identify a The information specified in this annotation is sufficient
- * to uniquely identify a
- * If the {@link Binding} for this
* For example, in the code below, the injected
- *
* If a JAX-WS implementation encounters an unsupported or unrecognized
- * annotation annotated with the
- * Example: The
* This interface is never implemented by an application,
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/ws/handler/soap/SOAPHandler.java
--- a/src/java.xml.ws/share/classes/javax/xml/ws/handler/soap/SOAPHandler.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/ws/handler/soap/SOAPHandler.java Thu Jul 16 19:27:53 2015 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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
@@ -29,7 +29,7 @@
import javax.xml.ws.handler.Handler;
import java.util.Set;
-/** The Since there is no standard format for faults or exceptions
@@ -39,7 +39,7 @@
private int statusCode;
/** Constructor for the HTTPException
- * @param statusCode
* This annotation's behaviour is defined by the corresponding feature
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/ws/soap/SOAPBinding.java
--- a/src/java.xml.ws/share/classes/javax/xml/ws/soap/SOAPBinding.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/ws/soap/SOAPBinding.java Thu Jul 16 19:27:53 2015 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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
@@ -70,7 +70,7 @@
/** Sets the roles played by the SOAP binding instance.
*
* @param roles The set of roles played by the binding instance.
- * @throws WebServiceException On an error in the configuration of
+ * @throws javax.xml.ws.WebServiceException On an error in the configuration of
* the list of roles.
**/
public void setRoles(Set A A {@code SOAPFaultException} wraps a SAAJ {@code SOAPFault}
* that manages the SOAP-specific representation of faults.
- * The Note that the value of Note that the value of {@code getFault} is the only part of the
* exception used when searializing a SOAP fault.
*
* Refer to the SOAP specification for a complete
@@ -55,7 +55,7 @@
private SOAPFault fault;
/** Constructor for SOAPFaultException
- * @param fault
* This method is package private so that this code can be shared.
*
- * @return the
- * Every
* Calling this method has the same behavior as the following
*
* This method behaves the same as calling
*
* This method behavies the same as calling
*
* The handler resolver, if present, will be called once for each
* proxy or dispatch instance that is created, and the handler chain
* returned by the resolver will be set on the instance.
*
- * @param handlerResolver The
- * A
* Servlet containers must expose {@link MessageContext#SERVLET_CONTEXT},
@@ -299,7 +299,7 @@
/**
* Gives all the attribute names that are associated with
- * this
- * When creating a
- * When creating a
- * When the
- * The
* See
* 2.1 Referencing WSDL Metadata from an EPR for more details.
*
* @param endpointName The name of the endpoint to be targeted
- * by the returned
@@ -187,10 +188,10 @@
* 2.1 Referencing WSDL Metadata from an EPR for more details.
*
* @param wsdlDocumentLocation The location of the WSDL document to
- * be referenced in the
- * This method can be used to create a features
- * parameter will have their default values.
+ * endpoint. Supported features not in the {@code features
+ * } parameter will have their default values.
*
*
* @return The newly created endpoint.
@@ -135,7 +135,7 @@
* {@link javax.xml.ws.Endpoint#publish(Object)} methods.
*
* @param bindingId A URI specifying the binding to use. If the bindingID is
- * null and no binding is specified via a BindingType
+ * {@code null} and no binding is specified via a BindingType
* annotation then a default SOAP 1.1 / HTTP binding MUST be used.
*
* @param implementor The endpoint implementor.
@@ -156,14 +156,14 @@
* {@link javax.xml.ws.Endpoint#publish(Object)} methods.
*
* @param bindingId A URI specifying the binding to use. If the bindingID is
- * null and no binding is specified via a BindingType
+ * {@code null} and no binding is specified via a BindingType
* annotation then a default SOAP 1.1 / HTTP binding MUST be used.
*
* @param implementor The endpoint implementor.
*
* @param features A list of WebServiceFeature to configure on the
- * endpoint. Supported features not in the features
- * parameter will have their default values.
+ * endpoint. Supported features not in the {@code features
+ * } parameter will have their default values.
*
* @return The newly created endpoint.
* @since 1.7, JAX-WS 2.2
@@ -205,9 +205,9 @@
* If the endpoint has been published already or it has been stopped.
*
* @throws java.lang.SecurityException
- * If a java.lang.SecurityManger
+ * If a {@code java.lang.SecurityManger}
* is being used and the application doesn't have the
- * WebServicePermission("publishEndpoint") permission.
+ * {@code WebServicePermission("publishEndpoint")} permission.
**/
public abstract void publish(String address);
@@ -231,9 +231,9 @@
* @return The newly created endpoint.
*
* @throws java.lang.SecurityException
- * If a java.lang.SecurityManger
+ * If a {@code java.lang.SecurityManger}
* is being used and the application doesn't have the
- * WebServicePermission("publishEndpoint") permission.
+ * {@code WebServicePermission("publishEndpoint")} permission.
*
**/
public static Endpoint publish(String address, Object implementor) {
@@ -258,14 +258,14 @@
* URI schemes.
* @param implementor The endpoint implementor.
* @param features A list of WebServiceFeature to configure on the
- * endpoint. Supported features not in the features
- * parameter will have their default values.
+ * endpoint. Supported features not in the {@code features
+ * } parameter will have their default values.
* @return The newly created endpoint.
*
* @throws java.lang.SecurityException
- * If a java.lang.SecurityManger
+ * If a {@code java.lang.SecurityManger}
* is being used and the application doesn't have the
- * WebServicePermission("publishEndpoint") permission.
+ * {@code WebServicePermission("publishEndpoint")} permission.
* @since 1.7, JAX-WS 2.2
*/
public static Endpoint publish(String address, Object implementor, WebServiceFeature ... features) {
@@ -294,9 +294,9 @@
* If the endpoint has been published already or it has been stopped.
*
* @throws java.lang.SecurityException
- * If a java.lang.SecurityManger
+ * If a {@code java.lang.SecurityManger}
* is being used and the application doesn't have the
- * WebServicePermission("publishEndpoint") permission.
+ * {@code WebServicePermission("publishEndpoint")} permission.
**/
public abstract void publish(Object serverContext);
@@ -327,9 +327,9 @@
* If the endpoint has been published already or it has been stopped.
*
* @throws java.lang.SecurityException
- * If a java.lang.SecurityManger
+ * If a {@code java.lang.SecurityManger}
* is being used and the application doesn't have the
- * WebServicePermission("publishEndpoint") permission.
+ * {@code WebServicePermission("publishEndpoint")} permission.
* @since 1.7, JAX-WS 2.2
*/
public void publish(HttpContext serverContext) {
@@ -348,14 +348,14 @@
/**
* Returns true if the endpoint is in the published state.
*
- * @return true if the endpoint is in the published state.
+ * @return {@code true} if the endpoint is in the published state.
**/
public abstract boolean isPublished();
/**
* Returns a list of metadata documents for the service.
*
- * @return List<javax.xml.transform.Source> A list of metadata documents for the service
+ * @return {@code ListEndpointinstance.
+ * Returns the executor for this {@code Endpoint}instance.
*
* The executor is used to dispatch an incoming request to
* the implementor object.
*
- * @return The java.util.concurrent.Executor to be
+ * @return The {@code java.util.concurrent.Executor} to be
* used to dispatch a request.
*
* @see java.util.concurrent.Executor
@@ -385,17 +385,17 @@
public abstract java.util.concurrent.Executor getExecutor();
/**
- * Sets the executor for this Endpoint instance.
+ * Sets the executor for this {@code Endpoint} instance.
*
* The executor is used to dispatch an incoming request to
* the implementor object.
*
- * If this Endpoint is published using the
- * publish(Object) method and the specified server
+ * If this {@code Endpoint} is published using the
+ * {@code publish(Object)} method and the specified server
* context defines its own threading behavior, the executor
* may be ignored.
*
- * @param executor The java.util.concurrent.Executor
+ * @param executor The {@code java.util.concurrent.Executor}
* to be used to dispatch a request.
*
* @throws SecurityException If the instance does not support
@@ -408,7 +408,7 @@
/**
- * Returns the property bag for this Endpoint instance.
+ * Returns the property bag for this {@code Endpoint} instance.
*
* @return Map<String,Object> The property bag
* associated with this instance.
@@ -416,7 +416,7 @@
public abstract MapEndpoint instance.
+ * Sets the property bag for this {@code Endpoint} instance.
*
* @param properties The property bag associated with
* this instance.
@@ -424,24 +424,24 @@
public abstract void setProperties(MapEndpointReference associated with
- * this Endpoint instance.
+ * Returns the {@code EndpointReference} associated with
+ * this {@code Endpoint} instance.
* bindingProvider is
+ * If the Binding for this {@code bindingProvider} is
* either SOAP1.1/HTTP or SOAP1.2/HTTP, then a
- * W3CEndpointReference MUST be returned.
+ * {@code W3CEndpointReference} MUST be returned.
*
* @param referenceParameters Reference parameters to be associated with the
- * returned EndpointReference instance.
- * @return EndpointReference of this Endpoint instance.
- * If the returned EndpointReference is of type
- * W3CEndpointReference then it MUST contain the
- * the specified referenceParameters.
+ * returned {@code EndpointReference} instance.
+ * @return EndpointReference of this {@code Endpoint} instance.
+ * If the returned {@code EndpointReference} is of type
+ * {@code W3CEndpointReference} then it MUST contain the
+ * the specified {@code referenceParameters}.
* @throws WebServiceException If any error in the creation of
- * the EndpointReference or if the Endpoint is
+ * the {@code EndpointReference} or if the {@code Endpoint} is
* not in the published state.
- * @throws UnsupportedOperationException If this BindingProvider
+ * @throws UnsupportedOperationException If this {@code BindingProvider}
* uses the XML/HTTP binding.
*
* @see W3CEndpointReference
@@ -452,23 +452,23 @@
/**
- * Returns the EndpointReference associated with
- * this Endpoint instance.
+ * Returns the {@code EndpointReference} associated with
+ * this {@code Endpoint} instance.
*
* @param clazz Specifies the type of EndpointReference that MUST be returned.
* @param referenceParameters Reference parameters to be associated with the
- * returned EndpointReference instance.
- * @return EndpointReference of type clazz of this
- * Endpoint instance.
- * If the returned EndpointReference is of type
- * W3CEndpointReference then it MUST contain the
- * the specified referenceParameters.
+ * returned {@code EndpointReference} instance.
+ * @return EndpointReference of type {@code clazz} of this
+ * {@code Endpoint} instance.
+ * If the returned {@code EndpointReference} is of type
+ * {@code W3CEndpointReference} then it MUST contain the
+ * the specified {@code referenceParameters}.
* @throws WebServiceException If any error in the creation of
- * the EndpointReference or if the Endpoint is
- * not in the published state or if the clazz is not a supported
- * EndpointReference type.
- * @throws UnsupportedOperationException If this BindingProvider
+ * the {@code EndpointReference} or if the {@code Endpoint} is
+ * not in the published state or if the {@code clazz} is not a supported
+ * {@code EndpointReference} type.
+ * @throws UnsupportedOperationException If this {@code BindingProvider}
* uses the XML/HTTP binding.
*
*
@@ -478,7 +478,7 @@
Element... referenceParameters);
/**
- * By settng a EndpointContext, JAX-WS runtime knows about
+ * By settng a {@code EndpointContext}, JAX-WS runtime knows about
* addresses of other endpoints in an application. If multiple endpoints
* share different ports of a WSDL, then the multiple port addresses
* are patched when the WSDL is accessed.
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/ws/EndpointContext.java
--- a/src/java.xml.ws/share/classes/javax/xml/ws/EndpointContext.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/ws/EndpointContext.java Thu Jul 16 19:27:53 2015 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2009, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2009, 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
@@ -25,11 +25,10 @@
package javax.xml.ws;
-import javax.xml.ws.Endpoint;
import java.util.Set;
/**
- * EndpointContext allows multiple endpoints in an application
+ * {@code EndpointContext} allows multiple endpoints in an application
* to share any information. For example, servlet application's war may
* contain multiple endpoints and these endpoints can get addresses of each
* other by sharing this context. If multiple endpoints share different
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/ws/EndpointReference.java
--- a/src/java.xml.ws/share/classes/javax/xml/ws/EndpointReference.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/ws/EndpointReference.java Thu Jul 16 19:27:53 2015 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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
@@ -44,35 +44,35 @@
* need not be concerned with its contents. The web service
* developer should use this class strictly as a mechanism to
* reference a remote web service endpoint. See the {@link Service} APIs
- * that clients can use to that utilize an EndpointReference.
+ * that clients can use to that utilize an {@code EndpointReference}.
* See the {@link javax.xml.ws.Endpoint}, and
* {@link javax.xml.ws.BindingProvider} APIs on how
- * EndpointReferences can be created for published
+ * {@code EndpointReferences} can be created for published
* endpoints.
* EndpointReference for a particular version of Addressing.
+ * an {@code EndpointReference} for a particular version of Addressing.
* For example the {@link W3CEndpointReference} is for use
* with W3C Web Services Addressing 1.0 - Core Recommendation.
* If JAX-WS implementors need to support different versions
* of addressing, they should write their own
- * EndpointReference subclass for that version.
+ * {@code EndpointReference} subclass for that version.
* This will allow a JAX-WS implementation to create
- * a vendor specific EndpointReferences that the
+ * a vendor specific {@code EndpointReferences} that the
* vendor can use to flag a different version of
* addressing.
* EndpointReference in Java methods in an
+ * {@code EndpointReference} in Java methods in an
* SEI should use
- * concrete instances of an EndpointReference such
- * as the W3CEndpointReference. This way the
+ * concrete instances of an {@code EndpointReference} such
+ * as the {@code W3CEndpointReference}. This way the
* schema mapped from the SEI will be more descriptive of the
* type of endpoint reference being passed.
* EndpointReferece using the
- * {@link EndpointReference#writeTo}
+ * from an {@code EndpointReferece} using the
+ * {@link EndpointReference#writeTo}
* method.
* eprInfoset. This method delegates to the vendor specific
+ * {@code eprInfoset}. This method delegates to the vendor specific
* implementation of the {@link javax.xml.ws.spi.Provider#readEndpointReference} method.
*
- * @param eprInfoset The EndpointReference infoset to be unmarshalled
+ * @param eprInfoset The {@code EndpointReference} infoset to be unmarshalled
*
- * @return the EndpointReference unmarshalled from eprInfoset
- * never null
+ * @return the EndpointReference unmarshalled from {@code eprInfoset}
+ * never {@code null}
* @throws WebServiceException
* if an error occurs while creating the
- * EndpointReference from the eprInfoset
+ * {@code EndpointReference} from the {@code eprInfoset}
* @throws java.lang.IllegalArgumentException
- * if the null eprInfoset value is given.
+ * if the {@code null} {@code eprInfoset} value is given.
*/
public static EndpointReference readFrom(Source eprInfoset) {
return Provider.provider().readEndpointReference(eprInfoset);
}
/**
- * write this EndpointReference to the specified infoset format
+ * write this {@code EndpointReference} to the specified infoset format
*
* @param result for writing infoset
* @throws WebServiceException
* if there is an error writing the
- * EndpointReference to the specified result.
+ * {@code EndpointReference} to the specified {@code result}.
*
* @throws java.lang.IllegalArgumentException
- * If the null result value is given.
+ * If the {@code null} {@code result} value is given.
*/
public abstract void writeTo(Result result);
/**
- * The getPort method returns a proxy. If there
+ * The {@code getPort} method returns a proxy. If there
* are any reference parameters in the
- * EndpointReference instance, then those reference
+ * {@code EndpointReference} instance, then those reference
* parameters MUST appear as SOAP headers, indicating them to be
* reference parameters, on all messages sent to the endpoint.
- * The parameter serviceEndpointInterface specifies
+ * The parameter {@code serviceEndpointInterface} specifies
* the service endpoint interface that is supported by the
* returned proxy.
- * The EndpointReference instance specifies the
+ * The {@code EndpointReference} instance specifies the
* endpoint that will be invoked by the returned proxy.
* In the implementation of this method, the JAX-WS
* runtime system takes the responsibility of selecting a protocol
* binding (and a port) and configuring the proxy accordingly from
- * the WSDL Metadata from this EndpointReference or from
- * annotations on the serviceEndpointInterface. For this method
+ * the WSDL Metadata from this {@code EndpointReference} or from
+ * annotations on the {@code serviceEndpointInterface}. For this method
* to successfully return a proxy, WSDL metadata MUST be available and the
- * EndpointReference instance MUST contain an implementation understood
- * serviceName metadata.
+ * {@code EndpointReference} instance MUST contain an implementation understood
+ * {@code serviceName} metadata.
* Service object, handlers
- * will not automatically be configured, and the HandlerResolver
- * and Executor cannot be get or set for this port. The
- * BindingProvider().getBinding().setHandlerChain()
+ * Because this port is not created from a {@code Service} object, handlers
+ * will not automatically be configured, and the {@code HandlerResolver}
+ * and {@code Executor} cannot be get or set for this port. The
+ * {@code BindingProvider().getBinding().setHandlerChain()}
* method can be used to manually configure handlers for this port.
*
*
* @param serviceEndpointInterface Service endpoint interface
- * @param features An array of WebServiceFeatures to configure on the
- * proxy. Supported features not in the features
- * parameter will have their default values.
+ * @param features An array of {@code WebServiceFeatures} to configure on the
+ * proxy. Supported features not in the {@code features
+ * } parameter will have their default values.
* @return Object Proxy instance that supports the
* specified service endpoint interface
* @throws WebServiceException
@@ -163,10 +163,10 @@
* endpointReference
+ * {@code endpointReference}
* is invalid
* serviceEndpointInterface
+ * {@code serviceEndpointInterface}
* is specified
* T.
+ * Holds a value of type {@code T}.
*
* @since 1.6, JAX-WS 2.0
*/
@@ -42,7 +42,7 @@
public T value;
/**
- * Creates a new holder with a null value.
+ * Creates a new holder with a {@code null} value.
*/
public Holder() {
}
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/ws/LogicalMessage.java
--- a/src/java.xml.ws/share/classes/javax/xml/ws/LogicalMessage.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/ws/LogicalMessage.java Thu Jul 16 19:27:53 2015 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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,7 +28,7 @@
import javax.xml.transform.Source;
import javax.xml.bind.JAXBContext;
-/** The LogicalMessage interface represents a
+/** The {@code LogicalMessage} interface represents a
* protocol agnostic XML message and contains methods that
* provide access to the payload of the message.
*
@@ -38,17 +38,17 @@
/** Gets the message payload as an XML source, may be called
* multiple times on the same LogicalMessage instance, always
- * returns a new Source that may be used to retrieve the entire
+ * returns a new {@code Source} that may be used to retrieve the entire
* message payload.
*
- * Source is an instance of
- * DOMSource, then
+ * setPayload. Other types of Source provide only
+ * {@code setPayload}. Other types of {@code Source} provide only
* read access to the message payload.
*
- * @return The contained message payload; returns null if no
+ * @return The contained message payload; returns {@code null} if no
* payload is present in this message.
**/
public Source getPayload();
@@ -65,11 +65,11 @@
/** Gets the message payload as a JAXB object. Note that there is no
* connection between the returned object and the message payload,
- * changes to the payload require calling setPayload.
+ * changes to the payload require calling {@code setPayload}.
*
* @param context The JAXBContext that should be used to unmarshall
* the message payload
- * @return The contained message payload; returns null if no
+ * @return The contained message payload; returns {@code null} if no
* payload is present in this message
* @throws WebServiceException If an error occurs when using a supplied
* JAXBContext to unmarshall the payload. The cause of
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/ws/ProtocolException.java
--- a/src/java.xml.ws/share/classes/javax/xml/ws/ProtocolException.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/ws/ProtocolException.java Thu Jul 16 19:27:53 2015 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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
@@ -25,7 +25,7 @@
package javax.xml.ws;
-/** The ProtocolException class is a
+/** The {@code ProtocolException} class is a
* base class for exceptions related to a specific protocol binding. Subclasses
* are used to communicate protocol level fault information to clients and may
* be used on the server to control the protocol specific fault representation.
@@ -34,9 +34,9 @@
**/
public class ProtocolException extends WebServiceException {
/**
- * Constructs a new protocol exception with null as its detail message. The
+ * Constructs a new protocol exception with {@code null} as its detail message. The
* cause is not initialized, and may subsequently be initialized by a call
- * to Throwable.initCause(java.lang.Throwable).
+ * to {@code Throwable.initCause(java.lang.Throwable)}.
*/
public ProtocolException() {
super();
@@ -45,7 +45,7 @@
/**
* Constructs a new protocol exception with the specified detail message.
* The cause is not initialized, and may subsequently be initialized by a
- * call to Throwable.initCause(java.lang.Throwable).
+ * call to {@code Throwable.initCause(java.lang.Throwable)}.
*
* @param message the detail message. The detail message is saved for later
* retrieval by the Throwable.getMessage() method.
@@ -64,7 +64,7 @@
* @param message the detail message (which is saved for later retrieval by
* the Throwable.getMessage() method).
* @param cause the cause (which is saved for later retrieval by the
- * Throwable.getCause() method). (A null value is permitted, and indicates
+ * {@code Throwable.getCause()} method). (A {@code null} value is permitted, and indicates
* that the cause is nonexistent or unknown.)
*/
public ProtocolException(String message, Throwable cause) {
@@ -73,13 +73,13 @@
/**
* Constructs a new runtime exception with the specified cause and a detail
- * message of (cause==null ? null : cause.toString()) (which typically
+ * message of {@code (cause==null ? null : cause.toString())} (which typically
* contains the class and detail message of cause). This constructor is
* useful for runtime exceptions that are little more than wrappers for
* other throwables.
*
* @param cause the cause (which is saved for later retrieval by the
- * Throwable.getCause() method). (A null value is permitted, and indicates
+ * {@code Throwable.getCause()} method). (A {@code null} value is permitted, and indicates
* that the cause is nonexistent or unknown.)
*/
public ProtocolException(Throwable cause) {
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/ws/Provider.java
--- a/src/java.xml.ws/share/classes/javax/xml/ws/Provider.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/ws/Provider.java Thu Jul 16 19:27:53 2015 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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
@@ -26,16 +26,16 @@
package javax.xml.ws;
/**
- * Provider
+ * Provider<Source>,
- * Provider<SOAPMessage> and
- * Provider<DataSource>, depending on the binding
+ * ServiceMode annotation can be used to control whether
- * the Provider instance will receive entire protocol messages
+ * null if
+ * @return The response message or message payload. May be {@code null} if
there is no response.
* @throws WebServiceException If there is an error processing request.
- * The cause of the WebServiceException may be set to a subclass
- * of ProtocolException to control the protocol level
+ * The cause of the {@code WebServiceException} may be set to a subclass
+ * of {@code ProtocolException} to control the protocol level
* representation of the exception.
* @see javax.xml.ws.handler.MessageContext
* @see javax.xml.ws.ProtocolException
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/ws/RequestWrapper.java
--- a/src/java.xml.ws/share/classes/javax/xml/ws/RequestWrapper.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/ws/RequestWrapper.java Thu Jul 16 19:27:53 2015 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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
@@ -33,11 +33,11 @@
/**
* Used to annotate methods in the Service Endpoint Interface with the request
- * wrapper bean to be used at runtime. The default value of the localName is
- * the operationName, as defined in WebMethod annotation and the
- * targetNamespace is the target namespace of the SEI.
+ * wrapper bean to be used at runtime. The default value of the {@code localName} is
+ * the {@code operationName}, as defined in {@code WebMethod} annotation and the
+ * {@code targetNamespace} is the target namespace of the SEI.
* className
+ * overloading conflicts in document literal mode. Only the {@code className}
* is required in this case.
*
* @since 1.6, JAX-WS 2.0
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/ws/RespectBinding.java
--- a/src/java.xml.ws/share/classes/javax/xml/ws/RespectBinding.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/ws/RespectBinding.java Thu Jul 16 19:27:53 2015 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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
@@ -34,18 +34,18 @@
/**
- * This feature clarifies the use of the wsdl:binding
+ * This feature clarifies the use of the {@code wsdl:binding}
* in a JAX-WS runtime.
* javax.jws.WebService, {@link WebServiceProvider},
+ * {@code javax.jws.WebService}, {@link WebServiceProvider},
* {@link WebServiceRef} annotations.
- * When used with the javax.jws.WebService annotation this
+ * When used with the {@code javax.jws.WebService} annotation this
* annotation MUST only be used on the service endpoint implementation
* class.
- * When used with a WebServiceRef annotation, this annotation
+ * When used with a {@code WebServiceRef} annotation, this annotation
* MUST only be used when a proxy instance is created. The injected SEI
- * proxy, and endpoint MUST honor the values of the RespectBinding
+ * proxy, and endpoint MUST honor the values of the {@code RespectBinding}
* annotation.
* wsdl:binding
+ * This feature clarifies the use of the {@code wsdl:binding}
* in a JAX-WS runtime.
*
* This feature can be used during the creation of SEI proxy, and
@@ -38,26 +38,26 @@
* wsdl:binding for an
- * endpoint at runtime to make sure that all wsdl:extensions
- * that have the required attribute set to true
+ * implementation inspect the {@code wsdl:binding} for an
+ * endpoint at runtime to make sure that all {@code wsdl:extensions}
+ * that have the {@code required} attribute set to {@code true}
* are understood and are being used.
*
*
*
* wsdl:binding extensions(including policies) are
+ * required {@code wsdl:binding} extensions(including policies) are
* either understood and used by the runtime, or explicitly disabled by the
* web service application. A web service can disable a particular
* extension if there is a corresponding {@link WebServiceFeature} or annotation.
* Similarly, a web service client can disable
- * particular extension using the corresponding WebServiceFeature while
+ * particular extension using the corresponding {@code WebServiceFeature} while
* creating a proxy or Dispatch instance.
* The runtime MUST also make sure that binding of
- * SEI parameters/return values respect the wsdl:binding.
- * With this feature enabled, if a required (wsdl:required="true")
- * wsdl:binding extension is in the WSDL and it is not
+ * SEI parameters/return values respect the {@code wsdl:binding}.
+ * With this feature enabled, if a required ({@code wsdl:required="true"})
+ * {@code wsdl:binding} extension is in the WSDL and it is not
* supported by a JAX-WS runtime and it has not
* been explicitly turned off by the web service developer, then
* that JAX-WS runtime MUST behave appropriately based on whether it is
@@ -71,8 +71,8 @@
* wsdl:binding or not and to what degree
- * the wsdl:binding will be inspected. For example,
+ * to inspect the {@code wsdl:binding} or not and to what degree
+ * the {@code wsdl:binding} will be inspected. For example,
* one implementation may choose to behave as if this feature is enabled,
* another implementation may only choose to verify the SEI's
* parameter/return type bindings.
@@ -91,7 +91,7 @@
/**
- * Creates an RespectBindingFeature.
+ * Creates an {@code RespectBindingFeature}.
* The instance created will be enabled.
*/
public RespectBindingFeature() {
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/ws/Response.java
--- a/src/java.xml.ws/share/classes/javax/xml/ws/Response.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/ws/Response.java Thu Jul 16 19:27:53 2015 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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,14 +28,14 @@
import java.util.Map;
import java.util.concurrent.Future;
-/** The Response interface provides methods used to obtain the
+/** The {@code Response} interface provides methods used to obtain the
* payload and context of a message sent in response to an operation
* invocation.
*
* get(...) methods may
+ * to check the status of the request. The {@code get(...)} methods may
* throw the standard
- * set of exceptions and their cause may be a RemoteException or a
+ * set of exceptions and their cause may be a {@code RemoteException} or a
* {@link WebServiceException} that represents the error that occured during the
* asynchronous method invocation.null if a
+ * @return The contained response context. May be {@code null} if a
* response is not yet available.
*
**/
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/ws/ResponseWrapper.java
--- a/src/java.xml.ws/share/classes/javax/xml/ws/ResponseWrapper.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/ws/ResponseWrapper.java Thu Jul 16 19:27:53 2015 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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
@@ -32,11 +32,11 @@
import java.lang.annotation.RetentionPolicy;
/**
* Used to annotate methods in the Service Endpoint Interface with the response
- * wrapper bean to be used at runtime. The default value of the localName is
- * the operationName as defined in WebMethod annotation appended with
- * Response and the targetNamespace is the target namespace of the SEI.
+ * wrapper bean to be used at runtime. The default value of the {@code localName} is
+ * the {@code operationName} as defined in {@code WebMethod} annotation appended with
+ * {@code Response} and the {@code targetNamespace} is the target namespace of the SEI.
* className
+ * overloading conflicts in document literal mode. Only the {@code className}
* is required in this case.
*
* @since 1.6, JAX-WS 2.0
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/ws/Service.java
--- a/src/java.xml.ws/share/classes/javax/xml/ws/Service.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/ws/Service.java Thu Jul 16 19:27:53 2015 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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
@@ -33,8 +33,8 @@
import javax.xml.ws.spi.Provider;
/**
- * Service objects provide the client view of a Web service.
- * Service acts as a factory of the following:
+ * {@code Service} objects provide the client view of a Web service.
+ *
*
*
* getPorts method. Alternatively, you can pass a
- * service endpoint interface to the unary getPort method
+ * {@code getPorts} method. Alternatively, you can pass a
+ * service endpoint interface to the unary {@code getPort} method
* and let the runtime select a compatible port.
*
- * Service
- * can be set by means of a HandlerResolver.
+ * Executor may be set on the service in order
+ * ThreadPoolExecutor and
+ * can be enabled by creating a {@code ThreadPoolExecutor} and
* registering it with the service.
*
* @since 1.6, JAX-WS 2.0
@@ -67,8 +67,8 @@
private ServiceDelegate delegate;
/**
- * The orientation of a dynamic client or service. MESSAGE provides
- * access to entire protocol message, PAYLOAD to protocol message
+ * The orientation of a dynamic client or service. {@code MESSAGE} provides
+ * access to entire protocol message, {@code PAYLOAD} to protocol message
* payload only.
**/
public enum Mode { MESSAGE, PAYLOAD }
@@ -87,9 +87,9 @@
/**
- * The getPort method returns a proxy. A service client
+ * The {@code getPort} method returns a proxy. A service client
* uses this proxy to invoke operations on the target
- * service endpoint. The serviceEndpointInterface
+ * service endpoint. The {@code serviceEndpointInterface}
* specifies the service endpoint interface that is supported by
* the created dynamic proxy instance.
*
@@ -108,8 +108,8 @@
* serviceEndpointInterface
- * or portName is specified.
+ * {@code serviceEndpointInterface}
+ * or {@code portName} is specified.
*
* @see java.lang.reflect.Proxy
* @see java.lang.reflect.InvocationHandler
@@ -120,9 +120,9 @@
}
/**
- * The getPort method returns a proxy. A service client
+ * The {@code getPort} method returns a proxy. A service client
* uses this proxy to invoke operations on the target
- * service endpoint. The serviceEndpointInterface
+ * service endpoint. The {@code serviceEndpointInterface}
* specifies the service endpoint interface that is supported by
* the created dynamic proxy instance.
*
@@ -131,8 +131,8 @@
* @param serviceEndpointInterface Service endpoint interface
* supported by the dynamic proxy instance.
* @param features A list of WebServiceFeatures to configure on the
- * proxy. Supported features not in the features
- * parameter will have their default values.
+ * proxy. Supported features not in the {@code features
+ * } parameter will have their default values.
* @return Object Proxy instance that
* supports the specified service endpoint
* interface.
@@ -144,8 +144,8 @@
* serviceEndpointInterface
- * or portName is specified.
+ * {@code serviceEndpointInterface}
+ * or {@code portName} is specified.
* getPort method returns a proxy. The parameter
- * serviceEndpointInterface specifies the service
+ * The {@code getPort} method returns a proxy. The parameter
+ * {@code serviceEndpointInterface} specifies the service
* endpoint interface that is supported by the returned proxy.
* In the implementation of this method, the JAX-WS
* runtime system takes the responsibility of selecting a protocol
@@ -180,7 +180,7 @@
* serviceEndpointInterface
+ * {@code serviceEndpointInterface}
* is specified.
*
**/
@@ -190,8 +190,8 @@
/**
- * The getPort method returns a proxy. The parameter
- * serviceEndpointInterface specifies the service
+ * The {@code getPort} method returns a proxy. The parameter
+ * {@code serviceEndpointInterface} specifies the service
* endpoint interface that is supported by the returned proxy.
* In the implementation of this method, the JAX-WS
* runtime system takes the responsibility of selecting a protocol
@@ -200,8 +200,8 @@
*
* @param serviceEndpointInterface Service endpoint interface.
* @param features A list of WebServiceFeatures to configure on the
- * proxy. Supported features not in the features
- * parameter will have their default values.
+ * proxy. Supported features not in the {@code features
+ * } parameter will have their default values.
* @return Object instance that supports the
* specified service endpoint interface.
* @throws WebServiceException
@@ -211,7 +211,7 @@
* serviceEndpointInterface
+ * {@code serviceEndpointInterface}
* is specified.
* getPort method returns a proxy.
- * The parameter endpointReference specifies the
+ * The {@code getPort} method returns a proxy.
+ * The parameter {@code endpointReference} specifies the
* endpoint that will be invoked by the returned proxy. If there
* are any reference parameters in the
- * endpointReference, then those reference
+ * {@code endpointReference}, then those reference
* parameters MUST appear as SOAP headers, indicating them to be
* reference parameters, on all messages sent to the endpoint.
- * The endpointReference's address MUST be used
+ * The {@code endpointReference's} address MUST be used
* for invocations on the endpoint.
- * The parameter serviceEndpointInterface specifies
+ * The parameter {@code serviceEndpointInterface} specifies
* the service endpoint interface that is supported by the
* returned proxy.
* In the implementation of this method, the JAX-WS
* runtime system takes the responsibility of selecting a protocol
* binding (and a port) and configuring the proxy accordingly from
- * the WSDL associated with this Service instance or
- * from the metadata from the endpointReference.
- * If this Service instance has a WSDL and
- * the endpointReference metadata
+ * the WSDL associated with this {@code Service} instance or
+ * from the metadata from the {@code endpointReference}.
+ * If this {@code Service} instance has a WSDL and
+ * the {@code endpointReference} metadata
* also has a WSDL, then the WSDL from this instance MUST be used.
- * If this Service instance does not have a WSDL and
- * the endpointReference does have a WSDL, then the
- * WSDL from the endpointReference MAY be used.
+ * If this {@code Service} instance does not have a WSDL and
+ * the {@code endpointReference} does have a WSDL, then the
+ * WSDL from the {@code endpointReference} MAY be used.
* The returned proxy should not be reconfigured by the client.
- * If this Service instance has a known proxy
+ * If this {@code Service} instance has a known proxy
* port that matches the information contained in
* the WSDL,
* then that proxy is returned, otherwise a WebServiceException
@@ -260,20 +260,20 @@
*
- *
- * where the port = service.getPort(portName, serviceEndpointInterface);
+ * {@code port = service.getPort(portName, serviceEndpointInterface);}
* portName is retrieved from the
- * metadata of the endpointReference or from the
- * serviceEndpointInterface and the WSDL
- * associated with this Service instance.
+ * where the {@code portName} is retrieved from the
+ * metadata of the {@code endpointReference} or from the
+ * {@code serviceEndpointInterface} and the WSDL
+ * associated with this {@code Service} instance.
*
- * @param endpointReference The EndpointReference
+ * @param endpointReference The {@code EndpointReference}
* for the target service endpoint that will be invoked by the
* returned proxy.
* @param serviceEndpointInterface Service endpoint interface.
- * @param features A list of WebServiceFeatures to configure on the
- * proxy. Supported features not in the features
- * parameter will have their default values.
+ * @param features A list of {@code WebServiceFeatures} to configure on the
+ * proxy. Supported features not in the {@code features
+ * } parameter will have their default values.
* @return Object Proxy instance that supports the
* specified service endpoint interface.
* @throws WebServiceException
@@ -282,16 +282,16 @@
* of the proxy.
* endpointReference metadata does
- * not match the serviceName of this
- * Service instance.
- * portName cannot be extracted
- * from the WSDL or endpointReference metadata.
+ * endpointReference
+ * {@code endpointReference}
* is specified.
* serviceEndpointInterface
+ * {@code serviceEndpointInterface}
* is specified.
* Dispatchinstances.
+ * {@code Dispatch}instances.
*
* @param portName Qualified name for the target service endpoint.
* @param bindingId A String identifier of a binding.
@@ -325,14 +325,14 @@
/**
- * Creates a Dispatch instance for use with objects of
+ * Creates a {@code Dispatch} instance for use with objects of
* the client's choosing.
*
* @param portName Qualified name for the target service endpoint
* @param type The class of object used for messages or message
* payloads. Implementations are required to support
- * javax.xml.transform.Source, javax.xml.soap.SOAPMessage
- * and javax.activation.DataSource, depending on
+ * {@code javax.xml.transform.Source}, {@code javax.xml.soap.SOAPMessage}
+ * and {@code javax.activation.DataSource}, depending on
* the binding in use.
* @param mode Controls whether the created dispatch instance is message
* or payload oriented, i.e. whether the client will work with complete
@@ -343,7 +343,7 @@
*
* @return Dispatch instance.
* @throws WebServiceException If any error in the creation of
- * the Dispatch object.
+ * the {@code Dispatch} object.
*
* @see javax.xml.transform.Source
* @see javax.xml.soap.SOAPMessage
@@ -354,26 +354,26 @@
/**
- * Creates a Dispatch instance for use with objects of
+ * Creates a {@code Dispatch} instance for use with objects of
* the client's choosing.
*
* @param portName Qualified name for the target service endpoint
* @param type The class of object used for messages or message
* payloads. Implementations are required to support
- * javax.xml.transform.Source and javax.xml.soap.SOAPMessage.
+ * {@code javax.xml.transform.Source} and {@code javax.xml.soap.SOAPMessage}.
* @param mode Controls whether the created dispatch instance is message
* or payload oriented, i.e. whether the client will work with complete
* protocol messages or message payloads. E.g. when using the SOAP
* protocol, this parameter controls whether the client will work with
- * SOAP messages or the contents of a SOAP body. Mode MUST be MESSAGE
- * when type is SOAPMessage.
- * @param features A list of WebServiceFeatures to configure on the
- * proxy. Supported features not in the features
- * parameter will have their default values.
+ * SOAP messages or the contents of a SOAP body. Mode MUST be {@code MESSAGE}
+ * when type is {@code SOAPMessage}.
+ * @param features A list of {@code WebServiceFeatures} to configure on the
+ * proxy. Supported features not in the {@code features
+ * } parameter will have their default values.
*
* @return Dispatch instance.
* @throws WebServiceException If any error in the creation of
- * the Dispatch object or if a
+ * the {@code Dispatch} object or if a
* feature is enabled that is not compatible with
* this port or is unsupported.
*
@@ -390,64 +390,64 @@
/**
- * Creates a Dispatch instance for use with objects of
+ * Creates a {@code Dispatch} instance for use with objects of
* the client's choosing. If there
* are any reference parameters in the
- * endpointReference, then those reference
+ * {@code endpointReference}, then those reference
* parameters MUST appear as SOAP headers, indicating them to be
* reference parameters, on all messages sent to the endpoint.
- * The endpointReference's address MUST be used
+ * The {@code endpointReference's} address MUST be used
* for invocations on the endpoint.
* In the implementation of this method, the JAX-WS
* runtime system takes the responsibility of selecting a protocol
* binding (and a port) and configuring the dispatch accordingly from
- * the WSDL associated with this Service instance or
- * from the metadata from the endpointReference.
- * If this Service instance has a WSDL and
- * the endpointReference
+ * the WSDL associated with this {@code Service} instance or
+ * from the metadata from the {@code endpointReference}.
+ * If this {@code Service} instance has a WSDL and
+ * the {@code endpointReference}
* also has a WSDL in its metadata, then the WSDL from this instance MUST be used.
- * If this Service instance does not have a WSDL and
- * the endpointReference does have a WSDL, then the
- * WSDL from the endpointReference MAY be used.
- * An implementation MUST be able to retrieve the portName from the
- * endpointReference metadata.
+ * If this {@code Service} instance does not have a WSDL and
+ * the {@code endpointReference} does have a WSDL, then the
+ * WSDL from the {@code endpointReference} MAY be used.
+ * An implementation MUST be able to retrieve the {@code portName} from the
+ * {@code endpointReference} metadata.
*
- *
- * where the dispatch = service.createDispatch(portName, type, mode, features);
+ * {@code dispatch = service.createDispatch(portName, type, mode, features);}
* portName is retrieved from the
- * WSDL or EndpointReference metadata.
+ * where the {@code portName} is retrieved from the
+ * WSDL or {@code EndpointReference} metadata.
*
- * @param endpointReference The EndpointReference
+ * @param endpointReference The {@code EndpointReference}
* for the target service endpoint that will be invoked by the
- * returned Dispatch object.
+ * returned {@code Dispatch} object.
* @param type The class of object used to messages or message
* payloads. Implementations are required to support
- * javax.xml.transform.Source and javax.xml.soap.SOAPMessage.
+ * {@code javax.xml.transform.Source} and {@code javax.xml.soap.SOAPMessage}.
* @param mode Controls whether the created dispatch instance is message
* or payload oriented, i.e. whether the client will work with complete
* protocol messages or message payloads. E.g. when using the SOAP
* protocol, this parameter controls whether the client will work with
- * SOAP messages or the contents of a SOAP body. Mode MUST be MESSAGE
- * when type is SOAPMessage.
- * @param features An array of WebServiceFeatures to configure on the
- * proxy. Supported features not in the features
- * parameter will have their default values.
+ * SOAP messages or the contents of a SOAP body. Mode MUST be {@code MESSAGE}
+ * when type is {@code SOAPMessage}.
+ * @param features An array of {@code WebServiceFeatures} to configure on the
+ * proxy. Supported features not in the {@code features
+ * } parameter will have their default values.
*
* @return Dispatch instance
* @throws WebServiceException
*
*
@@ -465,7 +465,7 @@
}
/**
- * Creates a endpointReference metadata does
- * not match the serviceName or portName
+ * Service instance.
- * portName cannot be determined
- * from the EndpointReference metadata.
+ * with this {@code Service} instance.
+ * Dispatch object.
+ * the {@code Dispatch} object.
* Dispatch instance for use with JAXB
+ * Creates a {@code Dispatch} instance for use with JAXB
* generated objects.
*
* @param portName Qualified name for the target service endpoint
@@ -479,7 +479,7 @@
*
* @return Dispatch instance.
* @throws WebServiceException If any error in the creation of
- * the Dispatch object.
+ * the {@code Dispatch} object.
*
* @see javax.xml.bind.JAXBContext
**/
@@ -490,7 +490,7 @@
/**
- * Creates a Dispatch instance for use with JAXB
+ * Creates a {@code Dispatch} instance for use with JAXB
* generated objects.
*
* @param portName Qualified name for the target service endpoint
@@ -501,13 +501,13 @@
* protocol messages or message payloads. E.g. when using the SOAP
* protocol, this parameter controls whether the client will work with
* SOAP messages or the contents of a SOAP body.
- * @param features A list of WebServiceFeatures to configure on the
- * proxy. Supported features not in the features
- * parameter will have their default values.
+ * @param features A list of {@code WebServiceFeatures} to configure on the
+ * proxy. Supported features not in the {@code features
+ * } parameter will have their default values.
*
* @return Dispatch instance.
* @throws WebServiceException If any error in the creation of
- * the Dispatch object or if a
+ * the {@code Dispatch} object or if a
* feature is enabled that is not compatible with
* this port or is unsupported.
*
@@ -523,39 +523,39 @@
/**
- * Creates a Dispatch instance for use with JAXB
+ * Creates a {@code Dispatch} instance for use with JAXB
* generated objects. If there
* are any reference parameters in the
- * endpointReference, then those reference
+ * {@code endpointReference}, then those reference
* parameters MUST appear as SOAP headers, indicating them to be
* reference parameters, on all messages sent to the endpoint.
- * The endpointReference's address MUST be used
+ * The {@code endpointReference's} address MUST be used
* for invocations on the endpoint.
* In the implementation of this method, the JAX-WS
* runtime system takes the responsibility of selecting a protocol
* binding (and a port) and configuring the dispatch accordingly from
- * the WSDL associated with this Service instance or
- * from the metadata from the endpointReference.
- * If this Service instance has a WSDL and
- * the endpointReference
+ * the WSDL associated with this {@code Service} instance or
+ * from the metadata from the {@code endpointReference}.
+ * If this {@code Service} instance has a WSDL and
+ * the {@code endpointReference}
* also has a WSDL in its metadata, then the WSDL from this instance
* MUST be used.
- * If this Service instance does not have a WSDL and
- * the endpointReference does have a WSDL, then the
- * WSDL from the endpointReference MAY be used.
- * An implementation MUST be able to retrieve the portName from the
- * endpointReference metadata.
+ * If this {@code Service} instance does not have a WSDL and
+ * the {@code endpointReference} does have a WSDL, then the
+ * WSDL from the {@code endpointReference} MAY be used.
+ * An implementation MUST be able to retrieve the {@code portName} from the
+ * {@code endpointReference} metadata.
*
- *
- * where the dispatch = service.createDispatch(portName, context, mode, features);
+ * {@code dispatch = service.createDispatch(portName, context, mode, features);}
* portName is retrieved from the
- * WSDL or endpointReference metadata.
+ * where the {@code portName} is retrieved from the
+ * WSDL or {@code endpointReference} metadata.
*
- * @param endpointReference The EndpointReference
+ * @param endpointReference The {@code EndpointReference}
* for the target service endpoint that will be invoked by the
- * returned Dispatch object.
+ * returned {@code Dispatch} object.
* @param context The JAXB context used to marshall and unmarshall
* messages or message payloads.
* @param mode Controls whether the created dispatch instance is message
@@ -563,23 +563,23 @@
* protocol messages or message payloads. E.g. when using the SOAP
* protocol, this parameter controls whether the client will work with
* SOAP messages or the contents of a SOAP body.
- * @param features An array of WebServiceFeatures to configure on the
- * proxy. Supported features not in the features
- * parameter will have their default values.
+ * @param features An array of {@code WebServiceFeatures} to configure on the
+ * proxy. Supported features not in the {@code features
+ * } parameter will have their default values.
*
* @return Dispatch instance
* @throws WebServiceException
*
*
@@ -604,12 +604,12 @@
}
/**
- * Returns an endpointReference metadata does
- * not match the serviceName or portName
+ * Service instance.
- * portName cannot be determined
- * from the EndpointReference metadata.
+ * with this {@code Service} instance.
+ * Dispatch object.
+ * the {@code Dispatch} object.
* Iterator for the list of
- * QNames of service endpoints grouped by this
+ * Returns an {@code Iterator} for the list of
+ * {@code QName}s of service endpoints grouped by this
* service
*
- * @return Returns java.util.Iterator with elements
- * of type javax.xml.namespace.QName.
+ * @return Returns {@code java.util.Iterator} with elements
+ * of type {@code javax.xml.namespace.QName}.
* @throws WebServiceException If this Service class does not
* have access to the required WSDL metadata.
**/
@@ -630,8 +630,8 @@
/**
* Returns the configured handler resolver.
*
- * @return HandlerResolver The HandlerResolver being
- * used by this Service instance, or null
+ * @return HandlerResolver The {@code HandlerResolver} being
+ * used by this {@code Service} instance, or {@code null}
* if there isn't one.
**/
public HandlerResolver getHandlerResolver() {
@@ -639,14 +639,14 @@
}
/**
- * Sets the HandlerResolver for this Service
+ * Sets the {@code HandlerResolver} for this {@code Service}
* instance.
* HandlerResolver to use
+ * @param handlerResolver The {@code HandlerResolver} to use
* for all subsequently created proxy/dispatch objects.
*
* @see javax.xml.ws.handler.HandlerResolver
@@ -656,12 +656,12 @@
}
/**
- * Returns the executor for this Serviceinstance.
+ * Returns the executor for this {@code Service}instance.
*
* The executor is used for all asynchronous invocations that
* require callbacks.
*
- * @return The java.util.concurrent.Executor to be
+ * @return The {@code java.util.concurrent.Executor} to be
* used to invoke a callback.
*
* @see java.util.concurrent.Executor
@@ -671,12 +671,12 @@
}
/**
- * Sets the executor for this Service instance.
+ * Sets the executor for this {@code Service} instance.
*
* The executor is used for all asynchronous invocations that
* require callbacks.
*
- * @param executor The java.util.concurrent.Executor
+ * @param executor The {@code java.util.concurrent.Executor}
* to be used to invoke a callback.
*
* @throws SecurityException If the instance does not support
@@ -690,14 +690,14 @@
}
/**
- * Creates a Service instance.
+ * Creates a {@code Service} instance.
*
* The specified WSDL document location and service qualified name MUST
- * uniquely identify a wsdl:service element.
+ * uniquely identify a {@code wsdl:service} element.
*
- * @param wsdlDocumentLocation URL for the WSDL document location
+ * @param wsdlDocumentLocation {@code URL} for the WSDL document location
* for the service
- * @param serviceName QName for the service
+ * @param serviceName {@code QName} for the service
* @throws WebServiceException If any error in creation of the
* specified service.
**/
@@ -708,15 +708,15 @@
}
/**
- * Creates a Service instance. The created instance is
+ * Creates a {@code Service} instance. The created instance is
* configured with the web service features.
*
* The specified WSDL document location and service qualified name MUST
- * uniquely identify a wsdl:service element.
+ * uniquely identify a {@code wsdl:service} element.
*
- * @param wsdlDocumentLocation URL for the WSDL document location
+ * @param wsdlDocumentLocation {@code URL} for the WSDL document location
* for the service
- * @param serviceName QName for the service
+ * @param serviceName {@code QName} for the service
* @param features Web Service features that must be configured on
* the service. If the provider doesn't understand a feature,
* it must throw a WebServiceException.
@@ -731,9 +731,9 @@
}
/**
- * Creates a Service instance.
+ * Creates a {@code Service} instance.
*
- * @param serviceName QName for the service
+ * @param serviceName {@code QName} for the service
* @throws WebServiceException If any error in creation of the
* specified service
*/
@@ -742,10 +742,10 @@
}
/**
- * Creates a Service instance. The created instance is
+ * Creates a {@code Service} instance. The created instance is
* configured with the web service features.
*
- * @param serviceName QName for the service
+ * @param serviceName {@code QName} for the service
* @param features Web Service features that must be configured on
* the service. If the provider doesn't understand a feature,
* it must throw a WebServiceException.
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/ws/ServiceMode.java
--- a/src/java.xml.ws/share/classes/javax/xml/ws/ServiceMode.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/ws/ServiceMode.java Thu Jul 16 19:27:53 2015 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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
@@ -44,9 +44,9 @@
@Documented
public @interface ServiceMode {
/**
- * Service mode. PAYLOAD indicates that the Provider implementation
- * wishes to work with protocol message payloads only. MESSAGE indicates
- * that the Provider implementation wishes to work with entire protocol
+ * Service mode. {@code PAYLOAD} indicates that the {@code Provider} implementation
+ * wishes to work with protocol message payloads only. {@code MESSAGE} indicates
+ * that the {@code Provider} implementation wishes to work with entire protocol
* messages.
**/
public Service.Mode value() default Service.Mode.PAYLOAD;
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/ws/WebEndpoint.java
--- a/src/java.xml.ws/share/classes/javax/xml/ws/WebEndpoint.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/ws/WebEndpoint.java Thu Jul 16 19:27:53 2015 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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
@@ -36,9 +36,9 @@
* methods of a generated service interface.
*
* wsdl:port element
- * inside a wsdl:service. The latter is
- * determined based on the value of the WebServiceClient
+ * to uniquely identify a {@code wsdl:port} element
+ * inside a {@code wsdl:service}. The latter is
+ * determined based on the value of the {@code WebServiceClient}
* annotation on the generated service interface itself.
*
* @since 1.6, JAX-WS 2.0
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/ws/WebServiceClient.java
--- a/src/java.xml.ws/share/classes/javax/xml/ws/WebServiceClient.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/ws/WebServiceClient.java Thu Jul 16 19:27:53 2015 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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
@@ -35,8 +35,8 @@
* Used to annotate a generated service interface.
*
* wsdl:service
- * element inside a WSDL document. This wsdl:service
+ * to uniquely identify a {@code wsdl:service}
+ * element inside a WSDL document. This {@code wsdl:service}
* element represents the Web service for which the generated
* service interface provides a client view.
*
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/ws/WebServiceContext.java
--- a/src/java.xml.ws/share/classes/javax/xml/ws/WebServiceContext.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/ws/WebServiceContext.java Thu Jul 16 19:27:53 2015 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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
@@ -32,14 +32,14 @@
/**
- * A WebServiceContext makes it possible for
+ * A {@code WebServiceContext} makes it possible for
* a web service endpoint implementation class to access
* message context and security information relative to
* a request being served.
*
- * Typically a WebServiceContext is injected
+ * Typically a {@code WebServiceContext} is injected
* into an endpoint implementation class using the
- * Resource annotation.
+ * {@code Resource} annotation.
*
* @since 1.6, JAX-WS 2.0
*
@@ -48,7 +48,7 @@
public interface WebServiceContext {
/**
- * Returns the MessageContext for the request being served
+ * Returns the {@code MessageContext} for the request being served
* at the time this method is called. Only properties with
* APPLICATION scope will be visible to the application.
*
@@ -68,7 +68,7 @@
* Returns the Principal that identifies the sender
* of the request currently being serviced. If the
* sender has not been authenticated, the method
- * returns null.
+ * returns {@code null}.
*
* @return Principal The principal object.
*
@@ -85,11 +85,11 @@
* Returns a boolean indicating whether the
* authenticated user is included in the specified
* logical role. If the user has not been
- * authenticated, the method returns false.
+ * authenticated, the method returns {@code false}.
*
- * @param role A String specifying the name of the role
+ * @param role A {@code String} specifying the name of the role
*
- * @return a boolean indicating whether
+ * @return a {@code boolean} indicating whether
* the sender of the request belongs to a given role
*
* @throws IllegalStateException This exception is thrown
@@ -99,20 +99,20 @@
public boolean isUserInRole(String role);
/**
- * Returns the EndpointReference for this
+ * Returns the {@code EndpointReference} for this
* endpoint.
* bindingProvider is
+ * If the {@link Binding} for this {@code bindingProvider} is
* either SOAP1.1/HTTP or SOAP1.2/HTTP, then a
- * W3CEndpointReference MUST be returned.
+ * {@code W3CEndpointReference} MUST be returned.
*
* @param referenceParameters Reference parameters to be associated with the
- * returned EndpointReference instance.
+ * returned {@code EndpointReference} instance.
* @return EndpointReference of the endpoint associated with this
- * WebServiceContext.
- * If the returned EndpointReference is of type
- * W3CEndpointReference then it MUST contain the
- * the specified referenceParameters.
+ * {@code WebServiceContext}.
+ * If the returned {@code EndpointReference} is of type
+ * {@code W3CEndpointReference} then it MUST contain the
+ * the specified {@code referenceParameters}.
*
* @throws IllegalStateException This exception is thrown
* if the method is called while no request is
@@ -125,24 +125,24 @@
public EndpointReference getEndpointReference(Element... referenceParameters);
/**
- * Returns the EndpointReference associated with
+ * Returns the {@code EndpointReference} associated with
* this endpoint.
*
- * @param clazz The type of EndpointReference that
+ * @param clazz The type of {@code EndpointReference} that
* MUST be returned.
* @param referenceParameters Reference parameters to be associated with the
- * returned EndpointReference instance.
- * @return EndpointReference of type clazz of the endpoint
- * associated with this WebServiceContext instance.
- * If the returned EndpointReference is of type
- * W3CEndpointReference then it MUST contain the
- * the specified referenceParameters.
+ * returned {@code EndpointReference} instance.
+ * @return EndpointReference of type {@code clazz} of the endpoint
+ * associated with this {@code WebServiceContext} instance.
+ * If the returned {@code EndpointReference} is of type
+ * {@code W3CEndpointReference} then it MUST contain the
+ * the specified {@code referenceParameters}.
*
* @throws IllegalStateException This exception is thrown
* if the method is called while no request is
* being serviced.
- * @throws WebServiceException If the clazz type of
- * EndpointReference is not supported.
+ * @throws WebServiceException If the {@code clazz} type of
+ * {@code EndpointReference} is not supported.
*
* @since 1.6, JAX-WS 2.1
**/
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/ws/WebServiceException.java
--- a/src/java.xml.ws/share/classes/javax/xml/ws/WebServiceException.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/ws/WebServiceException.java Thu Jul 16 19:27:53 2015 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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
@@ -25,7 +25,7 @@
package javax.xml.ws;
-/** The WebServiceException class is the base
+/** The {@code WebServiceException} class is the base
* exception class for all JAX-WS API runtime exceptions.
*
* @since 1.6, JAX-WS 2.0
@@ -33,7 +33,7 @@
public class WebServiceException extends java.lang.RuntimeException {
- /** Constructs a new exception with null as its
+ /** Constructs a new exception with {@code null} as its
* detail message. The cause is not initialized.
**/
public WebServiceException() {
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/ws/WebServiceFeature.java
--- a/src/java.xml.ws/share/classes/javax/xml/ws/WebServiceFeature.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/ws/WebServiceFeature.java Thu Jul 16 19:27:53 2015 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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
@@ -34,7 +34,7 @@
* JAX-WS implementors are free to define additional features if
* necessary. Vendor specific features may not be portable so
* caution should be used when using them. Each Feature definition
- * MUST define a public static final String ID
+ * MUST define a {@code public static final String ID}
* that can be used in the Feature annotation to refer
* to the feature. This ID MUST be unique across all features
* of all vendors. When defining a vendor specific feature ID,
@@ -71,9 +71,9 @@
/**
- * Returns true if this feature is enabled.
+ * Returns {@code true} if this feature is enabled.
*
- * @return true if and only if the feature is enabled .
+ * @return {@code true} if and only if the feature is enabled .
*/
public boolean isEnabled() {
return enabled;
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/ws/WebServiceRef.java
--- a/src/java.xml.ws/share/classes/javax/xml/ws/WebServiceRef.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/ws/WebServiceRef.java Thu Jul 16 19:27:53 2015 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2005, 2014, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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
@@ -34,7 +34,7 @@
import java.lang.annotation.RetentionPolicy;
/**
- * The WebServiceRef annotation is used to
+ * The {@code WebServiceRef} annotation is used to
* define a reference to a web service and
* (optionally) an injection target for it.
* It can be used to inject both service and proxy
@@ -47,21 +47,21 @@
* Web service references are resources in the Java EE 5 sense.
* The annotations (for example, {@link Addressing}) annotated with
* meta-annotation {@link WebServiceFeatureAnnotation}
- * can be used in conjunction with WebServiceRef.
+ * can be used in conjunction with {@code WebServiceRef}.
* The created reference MUST be configured with annotation's web service
* feature.
*
* StockQuoteProvider proxy MUST
+ * {@code StockQuoteProvider} proxy MUST
* have WS-Addressing enabled as specifed by the
* {@link Addressing}
* annotation.
*
*
* public class MyClient {
- * @Addressing
- * @WebServiceRef(StockQuoteService.class)
+ * {@literal @}Addressing
+ * {@literal @}WebServiceRef(StockQuoteService.class)
* private StockQuoteProvider stockQuoteProvider;
* ...
* }
@@ -69,8 +69,8 @@
*
* WebServiceFeatureAnnotation
- * that is specified with WebServiceRef, an ERROR MUST be given.
+ * annotation annotated with the {@code WebServiceFeatureAnnotation}
+ * that is specified with {@code WebServiceRef}, an ERROR MUST be given.
*
* @see javax.annotation.Resource
* @see WebServiceFeatureAnnotation
@@ -91,7 +91,7 @@
* and this MUST be specified.
*
* The JNDI name can be absolute(with any logical namespace) or relative
- * to JNDI java:comp/env namespace.
+ * to JNDI {@code java:comp/env} namespace.
*/
String name() default "";
@@ -106,11 +106,11 @@
/**
* A product specific name that this resource should be mapped to.
- * The name of this resource, as defined by the name
+ * The name of this resource, as defined by the {@code name}
* element or defaulted, is a name that is local to the application
* component using the resource. (When a relative JNDI name
* is specified, then it's a name in the JNDI
- * java:comp/env namespace.) Many application servers
+ * {@code java:comp/env} namespace.) Many application servers
* provide a way to map these local names to names of resources
* known to the application server. This mapped name is often a
* global JNDI name, but may be a name of any form.
@@ -124,7 +124,7 @@
/**
* The service class, always a type extending
- * javax.xml.ws.Service. This element MUST be specified
+ * {@code javax.xml.ws.Service}. This element MUST be specified
* whenever the type of the reference is a service endpoint interface.
*/
// 2.1 has Class value() default Object.class;
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/ws/WebServiceRefs.java
--- a/src/java.xml.ws/share/classes/javax/xml/ws/WebServiceRefs.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/ws/WebServiceRefs.java Thu Jul 16 19:27:53 2015 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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
@@ -32,7 +32,7 @@
import static java.lang.annotation.RetentionPolicy.*;
/**
- * The WebServiceRefs annotation allows
+ * The {@code WebServiceRefs} annotation allows
* multiple web service references to be declared at the
* class level.
*
@@ -50,13 +50,13 @@
* to inject the resource along with its features.
*
* StockQuoteProvider
- * proxy instance, and the StockQuoteService service
+ * Example: The {@code StockQuoteProvider}
+ * proxy instance, and the {@code StockQuoteService} service
* instance are injected using @WebServiceRefs.
*
*
- * @WebServiceRefs({@WebServiceRef(name="service/stockquoteservice", value=StockQuoteService.class),
- * @WebServiceRef(name="service/stockquoteprovider", type=StockQuoteProvider.class, value=StockQuoteService.class})
+ * {@literal @}WebServiceRefs({{@literal @}WebServiceRef(name="service/stockquoteservice", value=StockQuoteService.class),
+ * {@literal @}WebServiceRef(name="service/stockquoteprovider", type=StockQuoteProvider.class, value=StockQuoteService.class})
* public class MyClient {
* void init() {
* Context ic = new InitialContext();
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/ws/handler/Handler.java
--- a/src/java.xml.ws/share/classes/javax/xml/ws/handler/Handler.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/ws/handler/Handler.java Thu Jul 16 19:27:53 2015 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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,14 +28,14 @@
import javax.xml.ws.ProtocolException;
import javax.xml.ws.handler.MessageContext;
-/** The Handler interface
+/** The {@code Handler} interface
* is the base interface for JAX-WS handlers.
*
* @since 1.6, JAX-WS 2.0
**/
public interface HandlerhandleMessage method is invoked for normal processing
+ /** The {@code handleMessage} method is invoked for normal processing
* of inbound and outbound messages. Refer to the description of the handler
* framework in the JAX-WS specification for full details.
*
@@ -43,9 +43,9 @@
* @return An indication of whether handler processing should continue for
* the current message
*
- *
* @throws RuntimeException Causes the JAX-WS runtime to cease
@@ -55,7 +55,7 @@
**/
public boolean handleMessage(C context);
- /** The true to continue
+ * false to block
+ * handleFault method is invoked for fault message
+ /** The {@code handleFault} method is invoked for fault message
* processing. Refer to the description of the handler
* framework in the JAX-WS specification for full details.
*
@@ -63,9 +63,9 @@
* @return An indication of whether handler fault processing should continue
* for the current message
*
- *
* @throws RuntimeException Causes the JAX-WS runtime to cease
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/ws/handler/LogicalHandler.java
--- a/src/java.xml.ws/share/classes/javax/xml/ws/handler/LogicalHandler.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/ws/handler/LogicalHandler.java Thu Jul 16 19:27:53 2015 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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
@@ -25,7 +25,7 @@
package javax.xml.ws.handler;
-/** The true to continue
+ * false to block
+ * LogicalHandler extends
+/** The {@code LogicalHandler} extends
* Handler to provide typesafety for the message context parameter.
*
* @since 1.6, JAX-WS 2.0
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/ws/handler/LogicalMessageContext.java
--- a/src/java.xml.ws/share/classes/javax/xml/ws/handler/LogicalMessageContext.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/ws/handler/LogicalMessageContext.java Thu Jul 16 19:27:53 2015 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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
@@ -27,8 +27,8 @@
import javax.xml.ws.LogicalMessage;
-/** The LogicalMessageContext interface extends
- * MessageContext to
+/** The {@code LogicalMessageContext} interface extends
+ * {@code MessageContext} to
* provide access to a the contained message as a protocol neutral
* LogicalMessage
*
@@ -39,7 +39,7 @@
/** Gets the message from this message context
*
- * @return The contained message; returns null if no
+ * @return The contained message; returns {@code null} if no
* message is present in this message context
**/
public LogicalMessage getMessage();
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/ws/handler/PortInfo.java
--- a/src/java.xml.ws/share/classes/javax/xml/ws/handler/PortInfo.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/ws/handler/PortInfo.java Thu Jul 16 19:27:53 2015 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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,8 +28,8 @@
import javax.xml.namespace.QName;
/**
- * The PortInfo interface is used by a
- * HandlerResolver to query information about
+ * The {@code PortInfo} interface is used by a
+ * {@code HandlerResolver} to query information about
* the port it is being asked to create a handler chain for.
* SOAPHandler class extends Handler
+/** The {@code SOAPHandler} class extends {@code Handler}
* to provide typesafety for the message context parameter and add a method
* to obtain access to the headers that may be processed by the handler.
*
@@ -41,8 +41,8 @@
/** Gets the header blocks that can be processed by this Handler
* instance.
*
- * @return Set of QNames of header blocks processed by this
- * handler instance. QName is the qualified
+ * @return Set of {@code QNames} of header blocks processed by this
+ * handler instance. {@code QName} is the qualified
* name of the outermost element of the Header block.
**/
SetSOAPMessageContext
+/** The interface {@code SOAPMessageContext}
* provides access to the SOAP message for either RPC request or
- * response. The javax.xml.soap.SOAPMessage specifies
+ * response. The {@code javax.xml.soap.SOAPMessage} specifies
* the standard Java API for the representation of a SOAP 1.1 message
* with attachments.
*
@@ -43,20 +43,20 @@
public interface SOAPMessageContext
extends javax.xml.ws.handler.MessageContext {
- /** Gets the SOAPMessage from this message context. Modifications
- * to the returned SOAPMessage change the message in-place, there
- * is no need to subsequently call setMessage.
+ /** Gets the {@code SOAPMessage} from this message context. Modifications
+ * to the returned {@code SOAPMessage} change the message in-place, there
+ * is no need to subsequently call {@code setMessage}.
*
- * @return Returns the SOAPMessage; returns null if no
- * SOAPMessage is present in this message context
+ * @return Returns the {@code SOAPMessage}; returns {@code null} if no
+ * {@code SOAPMessage} is present in this message context
**/
public SOAPMessage getMessage();
/** Sets the SOAPMessage in this message context
*
* @param message SOAP message
- * @throws WebServiceException If any error during the setting
- * of the SOAPMessage in this message context
+ * @throws javax.xml.ws.WebServiceException If any error during the setting
+ * of the {@code SOAPMessage} in this message context
* @throws java.lang.UnsupportedOperationException If this
* operation is not supported
**/
@@ -69,16 +69,16 @@
* @param header The XML qualified name of the SOAP header(s).
* @param context The JAXBContext that should be used to unmarshall the
* header
- * @param allRoles If true then returns headers for all SOAP
- * roles, if false then only returns headers targetted
+ * @param allRoles If {@code true} then returns headers for all SOAP
+ * roles, if {@code false} then only returns headers targetted
* at the roles currently being played by this SOAP node, see
- * getRoles.
+ * {@code getRoles}.
* @return An array of unmarshalled headers; returns an empty array if no
* message is present in this message context or no headers match
* the supplied qualified name.
- * @throws WebServiceException If an error occurs when using the supplied
- * JAXBContext to unmarshall. The cause of
- * the WebServiceException is the original JAXBException.
+ * @throws javax.xml.ws.WebServiceException If an error occurs when using the supplied
+ * {@code JAXBContext} to unmarshall. The cause of
+ * the {@code WebServiceException} is the original {@code JAXBException}.
**/
public Object[] getHeaders(QName header, JAXBContext context,
boolean allRoles);
@@ -87,13 +87,13 @@
* of the handler chain.
* Note that SOAP actor roles apply to the SOAP node and
* are managed using {@link javax.xml.ws.soap.SOAPBinding#setRoles} and
- * {@link javax.xml.ws.soap.SOAPBinding#getRoles}. Handler instances in
+ * {@link javax.xml.ws.soap.SOAPBinding#getRoles}. {@code Handler} instances in
* the handler chain use this information about the SOAP actor
* roles to process the SOAP header blocks. Note that the
* SOAP actor roles are invariant during the processing of
* SOAP message through the handler chain.
*
- * @return Array of String for SOAP actor roles
+ * @return Array of {@code String} for SOAP actor roles
**/
public SetHTTPBinding interface is an
+/** The {@code HTTPBinding} interface is an
* abstraction for the XML/HTTP binding.
*
* @since 1.6, JAX-WS 2.0
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/ws/http/HTTPException.java
--- a/src/java.xml.ws/share/classes/javax/xml/ws/http/HTTPException.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/ws/http/HTTPException.java Thu Jul 16 19:27:53 2015 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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
@@ -26,7 +26,7 @@
package javax.xml.ws.http;
-/** The HTTPException exception represents a
+/** The {@code HTTPException} exception represents a
* XML/HTTP fault.
*
* int for the HTTP status code
+ * @param statusCode {@code int} for the HTTP status code
**/
public HTTPException(int statusCode) {
super();
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/ws/soap/Addressing.java
--- a/src/java.xml.ws/share/classes/javax/xml/ws/soap/Addressing.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/ws/soap/Addressing.java Thu Jul 16 19:27:53 2015 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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
@@ -46,12 +46,12 @@
* This annotation MUST only be used in conjunction with the
* {@link javax.jws.WebService}, {@link WebServiceProvider},
* and {@link WebServiceRef} annotations.
- * When used with a javax.jws.WebService annotation, this
+ * When used with a {@code javax.jws.WebService} annotation, this
* annotation MUST only be used on the service endpoint implementation
* class.
- * When used with a WebServiceRef annotation, this annotation
+ * When used with a {@code WebServiceRef} annotation, this annotation
* MUST only be used when a proxy instance is created. The injected SEI
- * proxy, and endpoint MUST honor the values of the Addressing
+ * proxy, and endpoint MUST honor the values of the {@code Addressing}
* annotation.
* SOAPFaultException exception represents a
+/** The {@code SOAPFaultException} exception represents a
* SOAP 1.1 or 1.2 fault.
*
- * SOAPFaultException wraps a SAAJ SOAPFault
+ * createFault method of
- * javax.xml.soap.SOAPFactory may be used to create an instance
- * of javax.xml.soap.SOAPFault for use with the
- * constructor. SOAPBinding contains an accessor for the
- * SOAPFactory used by the binding instance.
+ * The {@code createFault} method of
+ * {@code javax.xml.soap.SOAPFactory} may be used to create an instance
+ * of {@code javax.xml.soap.SOAPFault} for use with the
+ * constructor. {@code SOAPBinding} contains an accessor for the
+ * {@code SOAPFactory} used by the binding instance.
*
- * getFault is the only part of the
+ * SOAPFault representing the fault
+ * @param fault {@code SOAPFault} representing the fault
*
* @see javax.xml.soap.SOAPFactory#createFault
**/
@@ -64,9 +64,9 @@
this.fault = fault;
}
- /** Gets the embedded SOAPFault instance.
+ /** Gets the embedded {@code SOAPFault} instance.
*
- * @return javax.xml.soap.SOAPFault SOAP
+ * @return {@code javax.xml.soap.SOAPFault} SOAP
* fault element
**/
public javax.xml.soap.SOAPFault getFault() {
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/ws/spi/FactoryFinder.java
--- a/src/java.xml.ws/share/classes/javax/xml/ws/spi/FactoryFinder.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/ws/spi/FactoryFinder.java Thu Jul 16 19:27:53 2015 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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
@@ -34,7 +34,7 @@
/**
* Creates an instance of the specified class using the specified
- * ClassLoader object.
+ * {@code ClassLoader} object.
*
* @exception WebServiceException if the given class could not be found
* or could not be instantiated
@@ -56,22 +56,22 @@
}
/**
- * Finds the implementation Class object for the given
- * factory name, or if that fails, finds the Class object
+ * Finds the implementation {@code Class} object for the given
+ * factory name, or if that fails, finds the {@code Class} object
* for the given fallback class name. The arguments supplied MUST be
* used in order. If using the first argument is successful, the second
* one will not be used.
* Class object of the specified message factory;
- * may not be null
+ * @return the {@code Class} object of the specified message factory;
+ * may not be {@code null}
*
* @param factoryId the name of the factory to find, which is
* a system property
* @param fallbackClassName the implementation class name, which is
* to be used only if nothing else
- * is found; null to indicate that
+ * is found; {@code null} to indicate that
* there is no fallback class name
* @exception WebServiceException if there is an error
*/
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/ws/spi/Invoker.java
--- a/src/java.xml.ws/share/classes/javax/xml/ws/spi/Invoker.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/ws/spi/Invoker.java Thu Jul 16 19:27:53 2015 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2009, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2009, 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
@@ -37,8 +37,8 @@
* for a web service invocation. Finally, Invoker does the actual
* invocation of web service on endpoint instance.
*
- * Container also injects the provided WebServiceContext and takes
- * care of invoking javax.annotation.PostConstruct methods,
+ * Container also injects the provided {@code WebServiceContext} and takes
+ * care of invoking {@code javax.annotation.PostConstruct} methods,
* if present, on the endpoint implementation.
*
* @see Provider#createEndpoint(String, Class, Invoker, WebServiceFeature...)
@@ -51,7 +51,7 @@
/**
* JAX-WS runtimes calls this method to ask container to inject
* WebServiceContext on the endpoint instance. The
- * WebServiceContext object uses thread-local information
+ * {@code WebServiceContext} object uses thread-local information
* to return the correct information during the actual endpoint invocation
* regardless of how many threads are concurrently being used to serve
* requests.
@@ -70,7 +70,7 @@
/**
* JAX-WS runtime calls this method to do the actual web service
* invocation on endpoint instance. The injected
- * WebServiceContext.getMessageContext() gives the correct
+ * {@code WebServiceContext.getMessageContext()} gives the correct
* information for this invocation.
*
* @param m Method to be invoked on the service
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/ws/spi/Provider.java
--- a/src/java.xml.ws/share/classes/javax/xml/ws/spi/Provider.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/ws/spi/Provider.java Thu Jul 16 19:27:53 2015 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2005, 2014, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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
@@ -288,7 +288,7 @@
* method can automatically determine the {@code address} of
* an endpoint that is published by the same Java EE application and is
* identified by the {@code serviceName} and
- * {@code portName} propeties. If the {@code address} is
+ * {@code portName} properties. If the {@code address} is
* {@code null} and the {@code serviceName} and
* {@code portName} do not identify an endpoint published by the
* same Java EE application, a
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/ws/spi/ServiceDelegate.java
--- a/src/java.xml.ws/share/classes/javax/xml/ws/spi/ServiceDelegate.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/ws/spi/ServiceDelegate.java Thu Jul 16 19:27:53 2015 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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
@@ -37,11 +37,11 @@
/**
- * Service delegates are used internally by Service objects
+ * Service delegates are used internally by {@code Service} objects
* to allow pluggability of JAX-WS implementations.
* Service object has its own delegate, created using
- * the {@link javax.xml.ws.spi.Provider#createServiceDelegate} method. A Service
+ * Every {@code Service} object has its own delegate, created using
+ * the {@link javax.xml.ws.spi.Provider#createServiceDelegate} method. A {@code Service}
* object delegates all of its instance methods to its delegate.
*
* @see javax.xml.ws.Service
@@ -55,9 +55,9 @@
}
/**
- * The getPort method returns a proxy. A service client
+ * The {@code getPort} method returns a proxy. A service client
* uses this proxy to invoke operations on the target
- * service endpoint. The serviceEndpointInterface
+ * service endpoint. The {@code serviceEndpointInterface}
* specifies the service endpoint interface that is supported by
* the created dynamic proxy instance.
*
@@ -76,8 +76,8 @@
* serviceEndpointInterface
- * or portName is specified
+ * {@code serviceEndpointInterface}
+ * or {@code portName} is specified
*
* @see java.lang.reflect.Proxy
* @see java.lang.reflect.InvocationHandler
@@ -86,9 +86,9 @@
ClassgetPort method returns a proxy. A service client
+ * The {@code getPort} method returns a proxy. A service client
* uses this proxy to invoke operations on the target
- * service endpoint. The serviceEndpointInterface
+ * service endpoint. The {@code serviceEndpointInterface}
* specifies the service endpoint interface that is supported by
* the created dynamic proxy instance.
*
@@ -97,8 +97,8 @@
* @param serviceEndpointInterface Service endpoint interface
* supported by the dynamic proxy or instance
* @param features A list of WebServiceFeatures to configure on the
- * proxy. Supported features not in the features
- * parameter will have their default values.
+ * proxy. Supported features not in the {@code features
+ * } parameter will have their default values.
* @return Object Proxy instance that
* supports the specified service endpoint
* interface
@@ -110,8 +110,8 @@
* serviceEndpointInterface
- * or portName is specified
+ * {@code serviceEndpointInterface}
+ * or {@code portName} is specified
* getPort method returns a proxy.
- * The parameter endpointReference specifies the
+ * The {@code getPort} method returns a proxy.
+ * The parameter {@code endpointReference} specifies the
* endpoint that will be invoked by the returned proxy. If there
* are any reference parameters in the
- * endpointReference, then those reference
+ * {@code endpointReference}, then those reference
* parameters MUST appear as SOAP headers, indicating them to be
* reference parameters, on all messages sent to the endpoint.
- * The endpointReference's address MUST be used
+ * The {@code endpointReference's} address MUST be used
* for invocations on the endpoint.
- * The parameter serviceEndpointInterface specifies
+ * The parameter {@code serviceEndpointInterface} specifies
* the service endpoint interface that is supported by the
* returned proxy.
* In the implementation of this method, the JAX-WS
* runtime system takes the responsibility of selecting a protocol
* binding (and a port) and configuring the proxy accordingly from
- * the WSDL associated with this Service instance or
- * from the metadata from the endpointReference.
- * If this Service instance has a WSDL and
- * the endpointReference metadata
+ * the WSDL associated with this {@code Service} instance or
+ * from the metadata from the {@code endpointReference}.
+ * If this {@code Service} instance has a WSDL and
+ * the {@code endpointReference} metadata
* also has a WSDL, then the WSDL from this instance MUST be used.
- * If this Service instance does not have a WSDL and
- * the endpointReference does have a WSDL, then the
- * WSDL from the endpointReference MAY be used.
+ * If this {@code Service} instance does not have a WSDL and
+ * the {@code endpointReference} does have a WSDL, then the
+ * WSDL from the {@code endpointReference} MAY be used.
* The returned proxy should not be reconfigured by the client.
- * If this Service instance has a known proxy
+ * If this {@code Service} instance has a known proxy
* port that matches the information contained in
* the WSDL,
* then that proxy is returned, otherwise a WebServiceException
@@ -157,20 +157,20 @@
*
- *
- * where the port = service.getPort(portName, serviceEndpointInterface);
+ * {@code port = service.getPort(portName, serviceEndpointInterface);}
* portName is retrieved from the
- * metadata of the endpointReference or from the
- * serviceEndpointInterface and the WSDL
- * associated with this Service instance.
+ * where the {@code portName} is retrieved from the
+ * metadata of the {@code endpointReference} or from the
+ * {@code serviceEndpointInterface} and the WSDL
+ * associated with this {@code Service} instance.
*
- * @param endpointReference The EndpointReference
+ * @param endpointReference The {@code EndpointReference}
* for the target service endpoint that will be invoked by the
* returned proxy.
* @param serviceEndpointInterface Service endpoint interface.
- * @param features A list of WebServiceFeatures to configure on the
- * proxy. Supported features not in the features
- * parameter will have their default values.
+ * @param features A list of {@code WebServiceFeatures} to configure on the
+ * proxy. Supported features not in the {@code features
+ * } parameter will have their default values.
* @return Object Proxy instance that supports the
* specified service endpoint interface.
* @throws WebServiceException
@@ -179,16 +179,16 @@
* of the proxy.
* endpointReference metadata does
- * not match the serviceName of this
- * Service instance.
- * portName cannot be extracted
- * from the WSDL or endpointReference metadata.
+ * endpointReference
+ * {@code endpointReference}
* is specified.
* serviceEndpointInterface
+ * {@code serviceEndpointInterface}
* is specified.
* getPort method returns a proxy. The parameter
- * serviceEndpointInterface specifies the service
+ * The {@code getPort} method returns a proxy. The parameter
+ * {@code serviceEndpointInterface} specifies the service
* endpoint interface that is supported by the returned proxy.
* In the implementation of this method, the JAX-WS
* runtime system takes the responsibility of selecting a protocol
@@ -219,7 +219,7 @@
* serviceEndpointInterface
+ * {@code serviceEndpointInterface}
* is specified
*
**/
@@ -227,8 +227,8 @@
/**
- * The getPort method returns a proxy. The parameter
- * serviceEndpointInterface specifies the service
+ * The {@code getPort} method returns a proxy. The parameter
+ * {@code serviceEndpointInterface} specifies the service
* endpoint interface that is supported by the returned proxy.
* In the implementation of this method, the JAX-WS
* runtime system takes the responsibility of selecting a protocol
@@ -236,9 +236,9 @@
* The returned proxy should not be reconfigured by the client.
*
* @param serviceEndpointInterface Service endpoint interface
- * @param features An array of WebServiceFeatures to configure on the
- * proxy. Supported features not in the features
- * parameter will have their default values.
+ * @param features An array of {@code WebServiceFeatures} to configure on the
+ * proxy. Supported features not in the {@code features
+ * } parameter will have their default values.
* @return Object instance that supports the
* specified service endpoint interface
* @throws WebServiceException
@@ -248,7 +248,7 @@
* serviceEndpointInterface
+ * {@code serviceEndpointInterface}
* is specified
* Dispatchinstances.
+ * {@code Dispatch}instances.
*
* @param portName Qualified name for the target service endpoint
* @param bindingId A URI identifier of a binding.
@@ -283,23 +283,23 @@
/**
- * Creates a Dispatch instance for use with objects of
+ * Creates a {@code Dispatch} instance for use with objects of
* the user's choosing.
*
* @param portName Qualified name for the target service endpoint
* @param type The class of object used for messages or message
* payloads. Implementations are required to support
- * javax.xml.transform.Source and javax.xml.soap.SOAPMessage.
+ * {@code javax.xml.transform.Source} and {@code javax.xml.soap.SOAPMessage}.
* @param mode Controls whether the created dispatch instance is message
* or payload oriented, i.e. whether the user will work with complete
* protocol messages or message payloads. E.g. when using the SOAP
* protocol, this parameter controls whether the user will work with
- * SOAP messages or the contents of a SOAP body. Mode MUST be MESSAGE
- * when type is SOAPMessage.
+ * SOAP messages or the contents of a SOAP body. Mode MUST be {@code MESSAGE}
+ * when type is {@code SOAPMessage}.
*
* @return Dispatch instance
* @throws WebServiceException If any error in the creation of
- * the Dispatch object
+ * the {@code Dispatch} object
* @see javax.xml.transform.Source
* @see javax.xml.soap.SOAPMessage
**/
@@ -307,26 +307,26 @@
Service.Mode mode);
/**
- * Creates a Dispatch instance for use with objects of
+ * Creates a {@code Dispatch} instance for use with objects of
* the user's choosing.
*
* @param portName Qualified name for the target service endpoint
* @param type The class of object used for messages or message
* payloads. Implementations are required to support
- * javax.xml.transform.Source and javax.xml.soap.SOAPMessage.
+ * {@code javax.xml.transform.Source} and {@code javax.xml.soap.SOAPMessage}.
* @param mode Controls whether the created dispatch instance is message
* or payload oriented, i.e. whether the user will work with complete
* protocol messages or message payloads. E.g. when using the SOAP
* protocol, this parameter controls whether the user will work with
- * SOAP messages or the contents of a SOAP body. Mode MUST be MESSAGE
- * when type is SOAPMessage.
- * @param features A list of WebServiceFeatures to configure on the
- * proxy. Supported features not in the features
- * parameter will have their default values.
+ * SOAP messages or the contents of a SOAP body. Mode MUST be {@code MESSAGE}
+ * when type is {@code SOAPMessage}.
+ * @param features A list of {@code WebServiceFeatures} to configure on the
+ * proxy. Supported features not in the {@code features
+ * } parameter will have their default values.
*
* @return Dispatch instance
* @throws WebServiceException If any error in the creation of
- * the Dispatch object or if a
+ * the {@code Dispatch} object or if a
* feature is enabled that is not compatible with
* this port or is unsupported.
*
@@ -340,64 +340,64 @@
Service.Mode mode, WebServiceFeature... features);
/**
- * Creates a Dispatch instance for use with objects of
+ * Creates a {@code Dispatch} instance for use with objects of
* the user's choosing. If there
* are any reference parameters in the
- * endpointReference, then those reference
+ * {@code endpointReference}, then those reference
* parameters MUST appear as SOAP headers, indicating them to be
* reference parameters, on all messages sent to the endpoint.
- * The endpointReference's address MUST be used
+ * The {@code endpointReference's} address MUST be used
* for invocations on the endpoint.
* In the implementation of this method, the JAX-WS
* runtime system takes the responsibility of selecting a protocol
* binding (and a port) and configuring the dispatch accordingly from
- * the WSDL associated with this Service instance or
- * from the metadata from the endpointReference.
- * If this Service instance has a WSDL and
- * the endpointReference
+ * the WSDL associated with this {@code Service} instance or
+ * from the metadata from the {@code endpointReference}.
+ * If this {@code Service} instance has a WSDL and
+ * the {@code endpointReference}
* also has a WSDL in its metadata, then the WSDL from this instance MUST be used.
- * If this Service instance does not have a WSDL and
- * the endpointReference does have a WSDL, then the
- * WSDL from the endpointReference MAY be used.
- * An implementation MUST be able to retrieve the portName from the
- * endpointReference metadata.
+ * If this {@code Service} instance does not have a WSDL and
+ * the {@code endpointReference} does have a WSDL, then the
+ * WSDL from the {@code endpointReference} MAY be used.
+ * An implementation MUST be able to retrieve the {@code portName} from the
+ * {@code endpointReference} metadata.
*
- *
- * where the dispatch = service.createDispatch(portName, type, mode, features);
+ * {@code dispatch = service.createDispatch(portName, type, mode, features);}
* portName is retrieved from the
- * WSDL or EndpointReference metadata.
+ * where the {@code portName} is retrieved from the
+ * WSDL or {@code EndpointReference} metadata.
*
- * @param endpointReference The EndpointReference
+ * @param endpointReference The {@code EndpointReference}
* for the target service endpoint that will be invoked by the
- * returned Dispatch object.
+ * returned {@code Dispatch} object.
* @param type The class of object used to messages or message
* payloads. Implementations are required to support
- * javax.xml.transform.Source and javax.xml.soap.SOAPMessage.
+ * {@code javax.xml.transform.Source} and {@code javax.xml.soap.SOAPMessage}.
* @param mode Controls whether the created dispatch instance is message
* or payload oriented, i.e. whether the user will work with complete
* protocol messages or message payloads. E.g. when using the SOAP
* protocol, this parameter controls whether the user will work with
- * SOAP messages or the contents of a SOAP body. Mode MUST be MESSAGE
- * when type is SOAPMessage.
- * @param features An array of WebServiceFeatures to configure on the
- * proxy. Supported features not in the features
- * parameter will have their default values.
+ * SOAP messages or the contents of a SOAP body. Mode MUST be {@code MESSAGE}
+ * when type is {@code SOAPMessage}.
+ * @param features An array of {@code WebServiceFeatures} to configure on the
+ * proxy. Supported features not in the {@code features
+ * } parameter will have their default values.
*
* @return Dispatch instance
* @throws WebServiceException
*
*
@@ -415,7 +415,7 @@
/**
- * Creates a endpointReference metadata does
- * not match the serviceName or portName
+ * Service instance.
- * portName cannot be determined
- * from the EndpointReference metadata.
+ * with this {@code Service} instance.
+ * Dispatch object.
+ * the {@code Dispatch} object.
* Dispatch instance for use with JAXB
+ * Creates a {@code Dispatch} instance for use with JAXB
* generated objects.
*
* @param portName Qualified name for the target service endpoint
@@ -429,7 +429,7 @@
*
* @return Dispatch instance
* @throws WebServiceException If any error in the creation of
- * the Dispatch object
+ * the {@code Dispatch} object
*
* @see javax.xml.bind.JAXBContext
**/
@@ -438,7 +438,7 @@
/**
- * Creates a Dispatch instance for use with JAXB
+ * Creates a {@code Dispatch} instance for use with JAXB
* generated objects.
*
* @param portName Qualified name for the target service endpoint
@@ -449,13 +449,13 @@
* protocol messages or message payloads. E.g. when using the SOAP
* protocol, this parameter controls whether the user will work with
* SOAP messages or the contents of a SOAP body.
- * @param features A list of WebServiceFeatures to configure on the
- * proxy. Supported features not in the features
- * parameter will have their default values.
+ * @param features A list of {@code WebServiceFeatures} to configure on the
+ * proxy. Supported features not in the {@code features
+ * } parameter will have their default values.
*
* @return Dispatch instance
* @throws WebServiceException If any error in the creation of
- * the Dispatch object or if a
+ * the {@code Dispatch} object or if a
* feature is enabled that is not compatible with
* this port or is unsupported.
*
@@ -468,39 +468,39 @@
JAXBContext context, Service.Mode mode, WebServiceFeature... features);
/**
- * Creates a Dispatch instance for use with JAXB
+ * Creates a {@code Dispatch} instance for use with JAXB
* generated objects. If there
* are any reference parameters in the
- * endpointReference, then those reference
+ * {@code endpointReference}, then those reference
* parameters MUST appear as SOAP headers, indicating them to be
* reference parameters, on all messages sent to the endpoint.
- * The endpointReference's address MUST be used
+ * The {@code endpointReference's} address MUST be used
* for invocations on the endpoint.
* In the implementation of this method, the JAX-WS
* runtime system takes the responsibility of selecting a protocol
* binding (and a port) and configuring the dispatch accordingly from
- * the WSDL associated with this Service instance or
- * from the metadata from the endpointReference.
- * If this Service instance has a WSDL and
- * the endpointReference
+ * the WSDL associated with this {@code Service} instance or
+ * from the metadata from the {@code endpointReference}.
+ * If this {@code Service} instance has a WSDL and
+ * the {@code endpointReference}
* also has a WSDL in its metadata, then the WSDL from this instance
* MUST be used.
- * If this Service instance does not have a WSDL and
- * the endpointReference does have a WSDL, then the
- * WSDL from the endpointReference MAY be used.
- * An implementation MUST be able to retrieve the portName from the
- * endpointReference metadata.
+ * If this {@code Service} instance does not have a WSDL and
+ * the {@code endpointReference} does have a WSDL, then the
+ * WSDL from the {@code endpointReference} MAY be used.
+ * An implementation MUST be able to retrieve the {@code portName} from the
+ * {@code endpointReference} metadata.
*
- *
- * where the dispatch = service.createDispatch(portName, context, mode, features);
+ * {@code dispatch = service.createDispatch(portName, context, mode, features);}
* portName is retrieved from the
- * WSDL or endpointReference metadata.
+ * where the {@code portName} is retrieved from the
+ * WSDL or {@code endpointReference} metadata.
*
- * @param endpointReference The EndpointReference
+ * @param endpointReference The {@code EndpointReference}
* for the target service endpoint that will be invoked by the
- * returned Dispatch object.
+ * returned {@code Dispatch} object.
* @param context The JAXB context used to marshall and unmarshall
* messages or message payloads.
* @param mode Controls whether the created dispatch instance is message
@@ -508,23 +508,23 @@
* protocol messages or message payloads. E.g. when using the SOAP
* protocol, this parameter controls whether the user will work with
* SOAP messages or the contents of a SOAP body.
- * @param features An array of WebServiceFeatures to configure on the
- * proxy. Supported features not in the features
- * parameter will have their default values.
+ * @param features An array of {@code WebServiceFeatures} to configure on the
+ * proxy. Supported features not in the {@code features
+ * } parameter will have their default values.
*
* @return Dispatch instance
* @throws WebServiceException
*
*
@@ -546,12 +546,12 @@
public abstract QName getServiceName();
/**
- * Returns an endpointReference metadata does
- * not match the serviceName or portName
+ * Service instance.
- * portName cannot be determined
- * from the EndpointReference metadata.
+ * with this {@code Service} instance.
+ * Dispatch object.
+ * the {@code Dispatch} object.
* Iterator for the list of
- * QNames of service endpoints grouped by this
+ * Returns an {@code Iterator} for the list of
+ * {@code QName}s of service endpoints grouped by this
* service
*
- * @return Returns java.util.Iterator with elements
- * of type javax.xml.namespace.QName
+ * @return Returns {@code java.util.Iterator} with elements
+ * of type {@code javax.xml.namespace.QName}
* @throws WebServiceException If this Service class does not
* have access to the required WSDL metadata
**/
@@ -568,21 +568,21 @@
/**
* Returns the configured handler resolver.
*
- * @return HandlerResolver The HandlerResolver being
- * used by this Service instance, or null
+ * @return HandlerResolver The {@code HandlerResolver} being
+ * used by this {@code Service} instance, or {@code null}
* if there isn't one.
**/
public abstract HandlerResolver getHandlerResolver();
/**
- * Sets the HandlerResolver for this Service
+ * Sets the {@code HandlerResolver} for this {@code Service}
* instance.
* HandlerResolver to use
+ * @param handlerResolver The {@code HandlerResolver} to use
* for all subsequently created proxy/dispatch objects.
*
* @see javax.xml.ws.handler.HandlerResolver
@@ -590,12 +590,12 @@
public abstract void setHandlerResolver(HandlerResolver handlerResolver);
/**
- * Returns the executor for this Serviceinstance.
+ * Returns the executor for this {@code Service}instance.
*
* The executor is used for all asynchronous invocations that
* require callbacks.
*
- * @return The java.util.concurrent.Executor to be
+ * @return The {@code java.util.concurrent.Executor} to be
* used to invoke a callback.
*
* @see java.util.concurrent.Executor
@@ -603,12 +603,12 @@
public abstract java.util.concurrent.Executor getExecutor();
/**
- * Sets the executor for this Service instance.
+ * Sets the executor for this {@code Service} instance.
*
* The executor is used for all asynchronous invocations that
* require callbacks.
*
- * @param executor The java.util.concurrent.Executor
+ * @param executor The {@code java.util.concurrent.Executor}
* to be used to invoke a callback.
*
* @throws SecurityException If the instance does not support
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/ws/spi/http/HttpExchange.java
--- a/src/java.xml.ws/share/classes/javax/xml/ws/spi/http/HttpExchange.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/ws/spi/http/HttpExchange.java Thu Jul 16 19:27:53 2015 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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
@@ -41,7 +41,7 @@
* for examining the request from the client, and for building and
* sending the response.
* HttpExchange must be closed to free or reuse
+ * A {@code HttpExchange} must be closed to free or reuse
* underlying resources. The effect of failing to close an exchange
* is undefined.
*
@@ -277,7 +277,7 @@
/**
* Returns an attribute that is associated with this
- * HttpExchange. JAX-WS handlers and endpoints may then
+ * {@code HttpExchange}. JAX-WS handlers and endpoints may then
* access the attribute via {@link MessageContext}.
* HttpExchange.
+ * this {@code HttpExchange}.
*
* @return set of all attribute names
* @see #getAttribute(String)
@@ -308,7 +308,7 @@
/**
* Returns the {@link Principal} that represents the authenticated
- * user for this HttpExchange.
+ * user for this {@code HttpExchange}.
*
* @return Principal for an authenticated user, or
* null if not authenticated
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/ws/wsaddressing/W3CEndpointReference.java
--- a/src/java.xml.ws/share/classes/javax/xml/ws/wsaddressing/W3CEndpointReference.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/ws/wsaddressing/W3CEndpointReference.java Thu Jul 16 19:27:53 2015 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2005, 2014, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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
@@ -90,7 +90,7 @@
* If the source does NOT contain a valid W3C WS-Addressing
* EndpointReference.
* @throws NullPointerException
- * If the null source value is given
+ * If the {@code null} {@code source} value is given
*/
public W3CEndpointReference(Source source) {
try {
diff -r 5ce7ccacd056 -r 6232472e5141 src/java.xml.ws/share/classes/javax/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.java
--- a/src/java.xml.ws/share/classes/javax/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.java Thu Jul 16 13:51:53 2015 -0700
+++ b/src/java.xml.ws/share/classes/javax/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.java Thu Jul 16 19:27:53 2015 -0700
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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
@@ -38,35 +38,35 @@
/**
- * This class is used to build W3CEndpointReference
+ * This class is used to build {@code W3CEndpointReference}
* instances. The intended use of this clsss is for
* an application component, for example a factory component,
- * to create an W3CEndpointReference for a
+ * to create an {@code W3CEndpointReference} for a
* web service endpoint published by the same
* Java EE application. It can also be used to create
- * W3CEndpointReferences for an Java SE based
- * endpoint by providing the address property.
+ * {@code W3CEndpointReferences} for an Java SE based
+ * endpoint by providing the {@code address} property.
* W3CEndpointReference for an
+ * When creating a {@code W3CEndpointReference} for an
* endpoint that is not published by the same Java EE application,
- * the address property MUST be specified.
+ * the {@code address} property MUST be specified.
* W3CEndpointReference for an endpoint
- * published by the same Java EE application, the address
- * property MAY be null but then the serviceName
- * and endpointName MUST specify an endpoint published by
+ * When creating a {@code W3CEndpointReference} for an endpoint
+ * published by the same Java EE application, the {@code address}
+ * property MAY be {@code null} but then the {@code serviceName}
+ * and {@code endpointName} MUST specify an endpoint published by
* the same Java EE application.
* wsdlDocumentLocation is specified it MUST refer
- * to a valid WSDL document and the serviceName and
- * endpointName (if specified) MUST match a service and port
+ * When the {@code wsdlDocumentLocation} is specified it MUST refer
+ * to a valid WSDL document and the {@code serviceName} and
+ * {@code endpointName} (if specified) MUST match a service and port
* in the WSDL document.
*
* @since 1.6, JAX-WS 2.1
*/
public final class W3CEndpointReferenceBuilder {
/**
- * Creates a new W3CEndpointReferenceBuilder instance.
+ * Creates a new {@code W3CEndpointReferenceBuilder} instance.
*/
public W3CEndpointReferenceBuilder() {
referenceParameters = new ArrayListaddress to the
- * W3CEndpointReference instance's
- * wsa:Address.
+ * Sets the {@code address} to the
+ * {@code W3CEndpointReference} instance's
+ * {@code wsa:Address}.
* address MUST be set to a non-null
- * value when building a W3CEndpointReference for a
+ * The {@code address} MUST be set to a non-{@code null}
+ * value when building a {@code W3CEndpointReference} for a
* web service endpoint that is not published by the same
* Java EE application or when running on Java SE.
*
* @param address The address of the endpoint to be targeted
- * by the returned W3CEndpointReference.
+ * by the returned {@code W3CEndpointReference}.
*
- * @return A W3CEndpointReferenceBuilder instance with
- * the address set to the wsa:Address.
+ * @return A {@code W3CEndpointReferenceBuilder} instance with
+ * the {@code address} set to the {@code wsa:Address}.
*/
public W3CEndpointReferenceBuilder address(String address) {
this.address = address;
@@ -97,19 +97,19 @@
}
/**
- * Sets the interfaceName as the
- * wsam:InterfaceName element in the
- * wsa:Metadata element.
+ * Sets the {@code interfaceName} as the
+ * {@code wsam:InterfaceName} element in the
+ * {@code wsa:Metadata} element.
*
* See
* 2.1 Referencing WSDL Metadata from an EPR for more details.
*
* @param interfaceName The port type name of the endpoint to be targeted
- * by the returned W3CEndpointReference.
+ * by the returned {@code W3CEndpointReference}.
*
- * @return A W3CEndpointReferenceBuilder instance with
- * the interfaceName as wsam:InterfaceName
- * element added to the wsa:Metadata element
+ * @return A {@code W3CEndpointReferenceBuilder} instance with
+ * the {@code interfaceName} as {@code wsam:InterfaceName}
+ * element added to the {@code wsa:Metadata} element
* @since 1.7
*/
public W3CEndpointReferenceBuilder interfaceName(QName interfaceName) {
@@ -118,22 +118,22 @@
}
/**
- * Sets the serviceName as the
- * wsam:ServiceName element in the
- * wsa:Metadata element.
+ * Sets the {@code serviceName} as the
+ * {@code wsam:ServiceName} element in the
+ * {@code wsa:Metadata} element.
*
* See
* 2.1 Referencing WSDL Metadata from an EPR for more details.
*
* @param serviceName The service name of the endpoint to be targeted
- * by the returned W3CEndpointReference. This property
- * may also be used with the endpointName (portName)
- * property to lookup the address of a web service
+ * by the returned {@code W3CEndpointReference}. This property
+ * may also be used with the {@code endpointName} (portName)
+ * property to lookup the {@code address} of a web service
* endpoint that is published by the same Java EE application.
*
- * @return A W3CEndpointReferenceBuilder instance with
- * the serviceName as wsam:ServiceName
- * element added to the wsa:Metadata element
+ * @return A {@code W3CEndpointReferenceBuilder} instance with
+ * the {@code serviceName} as {@code wsam:ServiceName}
+ * element added to the {@code wsa:Metadata} element
*
*/
public W3CEndpointReferenceBuilder serviceName(QName serviceName) {
@@ -142,30 +142,31 @@
}
/**
- * Sets the endpointName as
- * wsam:ServiceName/@EndpointName in the
- * wsa:Metadata element. This method can only be called
+ * Sets the {@code endpointName} as
+ * {@code wsam:ServiceName/@EndpointName} in the
+ * {@code wsa:Metadata} element. This method can only be called
* after the {@link #serviceName} method has been called.
* W3CEndpointReference. The
- * endpointName (portName) property may also be
- * used with the serviceName property to lookup
- * the address of a web service
+ * by the returned {@code W3CEndpointReference}. The
+ * {@code endpointName} (portName) property may also be
+ * used with the {@code serviceName} property to lookup
+ * the {@code address} of a web service
* endpoint published by the same Java EE application.
*
- * @return A W3CEndpointReferenceBuilder instance with
- * the endpointName as
- * wsam:ServiceName/@EndpointName in the
- * wsa:Metadata element.
+ * @return A {@code W3CEndpointReferenceBuilder} instance with
+ * the {@code endpointName} as
+ * {@code wsam:ServiceName/@EndpointName} in the
+ * {@code wsa:Metadata} element.
*
- * @throws IllegalStateException, if the serviceName
- * has not been set.
- * @throws IllegalArgumentException, if the endpointName's
- * Namespace URI doesn't match serviceName's Namespace URI
+ * @throws java.lang.IllegalStateException if the {@code serviceName}
+ * has not been set
+ *
+ * @throws java.lang.IllegalArgumentException if the {@code endpointName}'s
+ * Namespace URI doesn't match {@code serviceName}'s Namespace URI
*
*/
public W3CEndpointReferenceBuilder endpointName(QName endpointName) {
@@ -178,8 +179,8 @@
}
/**
- * Sets the wsdlDocumentLocation that will be referenced
- * as wsa:Metadata/@wsdli:wsdlLocation. The namespace name
+ * Sets the {@code wsdlDocumentLocation} that will be referenced
+ * as {@code wsa:Metadata/@wsdli:wsdlLocation}. The namespace name
* for the wsdli:wsdlLocation's value can be taken from the WSDL itself.
*
* wsa:Metadata of the
- * W3CEndpointReference.
- * @return A W3CEndpointReferenceBuilder instance with
- * the wsdlDocumentLocation that is to be referenced.
+ * be referenced in the {@code wsa:Metadata} of the
+ * {@code W3CEndpointReference}.
+ * @return A {@code W3CEndpointReferenceBuilder} instance with
+ * the {@code wsdlDocumentLocation} that is to be referenced.
*/
public W3CEndpointReferenceBuilder wsdlDocumentLocation(String wsdlDocumentLocation) {
this.wsdlDocumentLocation = wsdlDocumentLocation;
@@ -198,19 +199,19 @@
}
/**
- * Adds the referenceParameter to the
- * W3CEndpointReference instance
- * wsa:ReferenceParameters element.
+ * Adds the {@code referenceParameter} to the
+ * {@code W3CEndpointReference} instance
+ * {@code wsa:ReferenceParameters} element.
*
* @param referenceParameter The element to be added to the
- * wsa:ReferenceParameters element.
+ * {@code wsa:ReferenceParameters} element.
*
- * @return A W3CEndpointReferenceBuilder instance with
- * the referenceParameter added to the
- * wsa:ReferenceParameters element.
+ * @return A {@code W3CEndpointReferenceBuilder} instance with
+ * the {@code referenceParameter} added to the
+ * {@code wsa:ReferenceParameters} element.
*
- * @throws java.lang.IllegalArgumentException if referenceParameter
- * is null.
+ * @throws java.lang.IllegalArgumentException if {@code referenceParameter}
+ * is {@code null}.
*/
public W3CEndpointReferenceBuilder referenceParameter(Element referenceParameter) {
if (referenceParameter == null)
@@ -220,19 +221,19 @@
}
/**
- * Adds the metadataElement to the
- * W3CEndpointReference instance's
- * wsa:Metadata element.
+ * Adds the {@code metadataElement} to the
+ * {@code W3CEndpointReference} instance's
+ * {@code wsa:Metadata} element.
*
* @param metadataElement The element to be added to the
- * wsa:Metadata element.
+ * {@code wsa:Metadata} element.
*
- * @return A W3CEndpointReferenceBuilder instance with
- * the metadataElement added to the
- * wsa:Metadata element.
+ * @return A {@code W3CEndpointReferenceBuilder} instance with
+ * the {@code metadataElement} added to the
+ * {@code wsa:Metadata} element.
*
- * @throws java.lang.IllegalArgumentException if metadataElement
- * is null.
+ * @throws java.lang.IllegalArgumentException if {@code metadataElement}
+ * is {@code null}.
*/
public W3CEndpointReferenceBuilder metadata(Element metadataElement) {
if (metadataElement == null)
@@ -243,16 +244,16 @@
/**
* Adds an extension element to the
- * W3CEndpointReference instance's
- * wsa:EndpointReference element.
+ * {@code W3CEndpointReference} instance's
+ * {@code wsa:EndpointReference} element.
*
* @param element The extension element to be added to the
- * W3CEndpointReference
- * @return A W3CEndpointReferenceBuilder instance with
- * the extension element added to the
- * W3CEndpointReference instance.
- * @throws java.lang.IllegalArgumentException if element
- * is null.
+ * {@code W3CEndpointReference}
+ * @return A {@code W3CEndpointReferenceBuilder} instance with
+ * the extension {@code element} added to the
+ * {@code W3CEndpointReference} instance.
+ * @throws java.lang.IllegalArgumentException if {@code element}
+ * is {@code null}.
*
* @since 1.7, JAX-WS 2.2
*/
@@ -266,17 +267,17 @@
/**
* Adds an extension attribute to the
- * W3CEndpointReference instance's
- * wsa:EndpointReference element.
+ * {@code W3CEndpointReference} instance's
+ * {@code wsa:EndpointReference} element.
*
* @param name The name of the extension attribute to be added to the
- * W3CEndpointReference
+ * {@code W3CEndpointReference}
* @param value extension attribute value
- * @return A W3CEndpointReferenceBuilder instance with
- * the extension attribute added to the W3CEndpointReference
+ * @return A {@code W3CEndpointReferenceBuilder} instance with
+ * the extension attribute added to the {@code W3CEndpointReference}
* instance.
- * @throws java.lang.IllegalArgumentException if name
- * or value is null.
+ * @throws java.lang.IllegalArgumentException if {@code name}
+ * or {@code value} is {@code null}.
*
* @since 1.7, JAX-WS 2.2
*/
@@ -289,48 +290,48 @@
}
/**
- * Builds a W3CEndpointReference from the accumulated
- * properties set on this W3CEndpointReferenceBuilder
+ * Builds a {@code W3CEndpointReference} from the accumulated
+ * properties set on this {@code W3CEndpointReferenceBuilder}
* instance.
* W3CEndpointReference
- * for any endpoint by specifying the address property along
+ * This method can be used to create a {@code W3CEndpointReference}
+ * for any endpoint by specifying the {@code address} property along
* with any other desired properties. This method
- * can also be used to create a W3CEndpointReference for
+ * can also be used to create a {@code W3CEndpointReference} for
* an endpoint that is published by the same Java EE application.
- * This method can automatically determine the address of
+ * This method can automatically determine the {@code address} of
* an endpoint published by the same Java EE application that is identified by the
- * serviceName and
- * endpointName properties. If the address is
- * null and the serviceName and
- * endpointName
+ * {@code serviceName} and
+ * {@code endpointName} properties. If the {@code address} is
+ * {@code null} and the {@code serviceName} and
+ * {@code endpointName}
* do not identify an endpoint published by the same Java EE application, a
- * java.lang.IllegalStateException MUST be thrown.
+ * {@code java.lang.IllegalStateException} MUST be thrown.
*
*
- * @return W3CEndpointReference from the accumulated
- * properties set on this W3CEndpointReferenceBuilder
- * instance. This method never returns null.
+ * @return {@code W3CEndpointReference} from the accumulated
+ * properties set on this {@code W3CEndpointReferenceBuilder}
+ * instance. This method never returns {@code null}.
*
* @throws IllegalStateException
*
- *
* @throws WebServiceException If an error occurs while creating the
- * address, serviceName and
- * endpointName are all null.
- * serviceName service is null and the
- * endpointName is NOT null.
- * address property is null and
- * the serviceName and endpointName do not
+ * serviceName is NOT null
+ * endpointName port is not null and it
- * is not present in serviceName service in the WSDL.
- * wsdlDocumentLocation is NOT null
+ * W3CEndpointReference.
+ * {@code W3CEndpointReference}.
*
*/
public W3CEndpointReference build() {