Improve javadoc for bean(), list() and stream() methods

Author: rbygrave

client/src/main/java/io/avaje/http/client/HttpAsyncResponse.java

@@ -106,9 +106,9 @@ public interface HttpAsyncResponse {
   /**
    * Process expecting a bean response body (typically from json content).
    * <p>
-   * If the HTTP statusCode is 300 or above a HttpException is throw
-   * which contains the HttpResponse. This is the cause in the
-   * CompletionException.
+   * If the HTTP statusCode is 300 or above a HttpException is throw which contains
+   * the HttpResponse. This is the cause in the CompletionException. Redirects are
+   * by default followed apart from HTTPS to HTTP.
    *
    * <pre>{@code
    *
@@ -141,9 +141,9 @@ public interface HttpAsyncResponse {
   /**
    * Process expecting a list of beans response body (typically from json content).
    * <p>
-   * If the HTTP statusCode is 300 or above a HttpException is throw
-   * which contains the HttpResponse. This is the cause in the
-   * CompletionException.
+   * If the HTTP statusCode is 300 or above a HttpException is throw which contains
+   * the HttpResponse. This is the cause in the CompletionException. Redirects are
+   * by default followed apart from HTTPS to HTTP.
    *
    * <pre>{@code
    *
@@ -181,9 +181,9 @@ public interface HttpAsyncResponse {
    * may not be available at the time of the callback. As such {@link RequestLogger}
    * will not include response content in logging stream request/response.
    * <p>
-   * If the HTTP statusCode is 300 or above a HttpException is throw
-   * which contains the HttpResponse. This is the cause in the
-   * CompletionException.
+   * If the HTTP statusCode is 300 or above a HttpException is throw which contains
+   * the HttpResponse. This is the cause in the CompletionException. Redirects are
+   * by default followed apart from HTTPS to HTTP.
    *
    * <pre>{@code
    *

client/src/main/java/io/avaje/http/client/HttpClientResponse.java

@@ -29,6 +29,10 @@ public interface HttpClientResponse {
 
   /**
    * Return the response as a single bean.
+   * <p>
+   * If the HTTP statusCode is 300 or above a HttpException is throw which contains
+   * the HttpResponse. This is the cause in the CompletionException. Redirects are
+   * by default followed apart from HTTPS to HTTP.
    *
    * @param type The type of the bean to convert the response content into.
    * @param <T>  The type that the content is converted to.
@@ -39,6 +43,10 @@ public interface HttpClientResponse {
 
   /**
    * Return the response as a list of beans.
+   * <p>
+   * If the HTTP statusCode is 300 or above a HttpException is throw which contains
+   * the HttpResponse. This is the cause in the CompletionException. Redirects are
+   * by default followed apart from HTTPS to HTTP.
    *
    * @param type The type of the bean to convert the response content into.
    * @param <T>  The type that the content is converted to.
@@ -57,6 +65,10 @@ public interface HttpClientResponse {
    * 'loggable' by avaje-http-client. This is because the entire response
    * may not be available at the time of the callback. As such {@link RequestLogger}
    * will not include response content when logging stream request/response
+   * <p>
+   * If the HTTP statusCode is 300 or above a HttpException is throw which contains
+   * the HttpResponse. This is the cause in the CompletionException. Redirects are
+   * by default followed apart from HTTPS to HTTP.
    *
    * @param type The type of the bean to convert the response content into.
    * @param <T>  The type that the content is converted to.
@@ -87,6 +99,8 @@ public interface HttpClientResponse {
 
   /**
    * Return the response discarding the response content.
+   * <p>
+   * Unlike {@link #asVoid()} this does not check the response status code.
    */
   HttpResponse<Void> asDiscarding();