http-client-branch: add RFC links to the package description. Add javadoc to the public Exception types http-client-branch
authorchegar
Tue, 13 Feb 2018 15:28:07 +0000
branchhttp-client-branch
changeset 56121 dca5d4a9f4e3
parent 56120 5db317238575
child 56122 1d7d3d8f8021
http-client-branch: add RFC links to the package description. Add javadoc to the public Exception types
src/java.net.http/share/classes/java/net/http/HttpTimeoutException.java
src/java.net.http/share/classes/java/net/http/WebSocketHandshakeException.java
src/java.net.http/share/classes/java/net/http/package-info.java
--- a/src/java.net.http/share/classes/java/net/http/HttpTimeoutException.java	Tue Feb 13 14:42:41 2018 +0000
+++ b/src/java.net.http/share/classes/java/net/http/HttpTimeoutException.java	Tue Feb 13 15:28:07 2018 +0000
@@ -36,6 +36,12 @@
 
     private static final long serialVersionUID = 981344271622632951L;
 
+    /**
+     * Constructs an {@code HttpTimeoutException} with the given detail message.
+     *
+     * @param message
+     *        The detail message; can be {@code null}
+     */
     public HttpTimeoutException(String message) {
         super(message);
     }
--- a/src/java.net.http/share/classes/java/net/http/WebSocketHandshakeException.java	Tue Feb 13 14:42:41 2018 +0000
+++ b/src/java.net.http/share/classes/java/net/http/WebSocketHandshakeException.java	Tue Feb 13 15:28:07 2018 +0000
@@ -38,6 +38,13 @@
 
     private final transient HttpResponse<?> response;
 
+    /**
+     * Constructs a {@code WebSocketHandshakeException} with the given
+     * {@code HttpResponse}.
+     *
+     * @param response
+     *        the {@code HttpResponse} that resulted in the handshake failure
+     */
     public WebSocketHandshakeException(HttpResponse<?> response) {
         this.response = response;
     }
@@ -46,7 +53,7 @@
      * Returns the server's counterpart of the opening handshake.
      *
      * <p> The value may be unavailable ({@code null}) if this exception has
-     * been serialized and then read back in.
+     * been serialized and then deserialized.
      *
      * @return server response
      */
--- a/src/java.net.http/share/classes/java/net/http/package-info.java	Tue Feb 13 14:42:41 2018 +0000
+++ b/src/java.net.http/share/classes/java/net/http/package-info.java	Tue Feb 13 15:28:07 2018 +0000
@@ -36,6 +36,12 @@
  *    <li>{@link java.net.http.WebSocket}</li>
  * </ul>
  *
+ * <p> The HTTP protocol specific requirements are specified in the
+ * <a href="https://tools.ietf.org/html/rfc7540">Hypertext Transfer Protocol
+ * Version 2 (HTTP/2)</a>, the <a href=https://tools.ietf.org/html/rfc2616>
+ * Hypertext Transfer Protocol (HTTP/1.1)</a>, and
+ * <a href="https://tools.ietf.org/html/rfc6455">The WebSocket Protocol</a>.
+ *
  * <p> Asynchronous tasks and dependent actions of returned {@link
  * java.util.concurrent.CompletableFuture} instances are executed on the threads
  * supplied by the client's {@link java.util.concurrent.Executor}, where