src/jdk.incubator.httpclient/share/classes/jdk/incubator/http/HttpClient.java
branchhttp-client-branch
changeset 56043 08e8e41841cf
parent 56025 1f88e1587067
child 56079 d23b02f37fce
--- a/src/jdk.incubator.httpclient/share/classes/jdk/incubator/http/HttpClient.java	Mon Jan 29 15:18:25 2018 +0000
+++ b/src/jdk.incubator.httpclient/share/classes/jdk/incubator/http/HttpClient.java	Mon Jan 29 18:12:36 2018 +0000
@@ -207,6 +207,10 @@
          * will use HTTP/2. If the upgrade fails, then the response will be
          * handled using HTTP/1.1
          *
+         * @implNote Constraints may also affect the selection of protocol version. 
+         * For example, if HTTP/2 is requested through a proxy, and if the implementation
+         * does not support this mode, then HTTP/1.1 may be used
+         *
          * @param version the requested HTTP protocol version
          * @return this builder
          */
@@ -328,9 +332,13 @@
     public abstract Optional<Authenticator> authenticator();
 
     /**
-     * Returns the HTTP protocol version requested for this client. The default
+     * Returns the preferred HTTP protocol version for this client. The default
      * value is {@link HttpClient.Version#HTTP_2}
      *
+     * @implNote Constraints may also affect the selection of protocol version. 
+     * For example, if HTTP/2 is requested through a proxy, and if the implementation
+     * does not support this mode, then HTTP/1.1 may be used
+     *
      * @return the HTTP protocol version requested
      */
     public abstract HttpClient.Version version();