Update javadoc to use 2XX range terminology

rbygrave · rbygrave · commit 7868eb68064a · 2021-07-07T16:57:34.000+12:00
diff --git a/client/src/main/java/io/avaje/http/client/HttpAsyncResponse.java b/client/src/main/java/io/avaje/http/client/HttpAsyncResponse.java
@@ -177,9 +177,8 @@ 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. Redirects are
-   * by default followed apart from HTTPS to HTTP.
+   * If the HTTP statusCode is not in the 2XX range a HttpException is throw which contains
+   * the HttpResponse. This is the cause in the CompletionException.
    *
    * <pre>{@code
    *
@@ -212,9 +211,8 @@ 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. Redirects are
-   * by default followed apart from HTTPS to HTTP.
+   * If the HTTP statusCode is not in the 2XX range a HttpException is throw which contains
+   * the HttpResponse. This is the cause in the CompletionException.
    *
    * <pre>{@code
    *
@@ -252,9 +250,8 @@ 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. Redirects are
-   * by default followed apart from HTTPS to HTTP.
+   * If the HTTP statusCode is not in the 2XX range a HttpException is throw which contains
+   * the HttpResponse. This is the cause in the CompletionException.
    *
    * <pre>{@code
    *
diff --git a/client/src/main/java/io/avaje/http/client/HttpCallResponse.java b/client/src/main/java/io/avaje/http/client/HttpCallResponse.java
@@ -120,9 +120,8 @@ public interface HttpCallResponse {
   /**
    * A bean response to execute async or sync.
    * <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.
+   * If the HTTP statusCode is not in the 2XX range a HttpException is throw which contains
+   * the HttpResponse. This is the cause in the CompletionException.
    *
    * <pre>{@code
    *
@@ -142,9 +141,8 @@ public interface HttpCallResponse {
   /**
    * 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. Redirects are
-   * by default followed apart from HTTPS to HTTP.
+   * If the HTTP statusCode is not in the 2XX range a HttpException is throw which contains
+   * the HttpResponse. This is the cause in the CompletionException.
    *
    * <pre>{@code
    *
@@ -163,9 +161,8 @@ public interface HttpCallResponse {
   /**
    * Process expecting a stream 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. Redirects are
-   * by default followed apart from HTTPS to HTTP.
+   * If the HTTP statusCode is not in the 2XX range a HttpException is throw which contains
+   * the HttpResponse. This is the cause in the CompletionException.
    *
    * <pre>{@code
    *
diff --git a/client/src/main/java/io/avaje/http/client/HttpClientResponse.java b/client/src/main/java/io/avaje/http/client/HttpClientResponse.java
@@ -36,9 +36,8 @@ 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.
+   * If the HTTP statusCode is not in the 2XX range a HttpException is throw which contains
+   * the HttpResponse. This is the cause in the CompletionException.
    *
    * @param type The type of the bean to convert the response content into.
    * @param <T>  The type that the content is converted to.
@@ -50,9 +49,8 @@ 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.
+   * If the HTTP statusCode is not in the 2XX range a HttpException is throw which contains
+   * the HttpResponse. This is the cause in the CompletionException.
    *
    * @param type The type of the bean to convert the response content into.
    * @param <T>  The type that the content is converted to.
@@ -72,9 +70,8 @@ public interface HttpClientResponse {
    * 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.
+   * If the HTTP statusCode is not in the 2XX range a HttpException is throw which contains
+   * the HttpResponse. This is the cause in the CompletionException.
    *
    * @param type The type of the bean to convert the response content into.
    * @param <T>  The type that the content is converted to.

Original file line number	Diff line number	Diff line change
`@@ -177,9 +177,8 @@ public interface HttpAsyncResponse {`
`177`	`177`	`/**`
`178`	`178`	`* Process expecting a bean response body (typically from json content).`
`179`	`179`	`* <p>`
`180`		`- * If the HTTP statusCode is 300 or above a HttpException is throw which contains`
`181`		`- * the HttpResponse. This is the cause in the CompletionException. Redirects are`
`182`		`- * by default followed apart from HTTPS to HTTP.`
	`180`	`+ * If the HTTP statusCode is not in the 2XX range a HttpException is throw which contains`
	`181`	`+ * the HttpResponse. This is the cause in the CompletionException.`
`183`	`182`	`*`
`184`	`183`	`* <pre>{@code`
`185`	`184`	`*`
`@@ -212,9 +211,8 @@ public interface HttpAsyncResponse {`
`212`	`211`	`/**`
`213`	`212`	`* Process expecting a list of beans response body (typically from json content).`
`214`	`213`	`* <p>`
`215`		`- * If the HTTP statusCode is 300 or above a HttpException is throw which contains`
`216`		`- * the HttpResponse. This is the cause in the CompletionException. Redirects are`
`217`		`- * by default followed apart from HTTPS to HTTP.`
	`214`	`+ * If the HTTP statusCode is not in the 2XX range a HttpException is throw which contains`
	`215`	`+ * the HttpResponse. This is the cause in the CompletionException.`
`218`	`216`	`*`
`219`	`217`	`* <pre>{@code`
`220`	`218`	`*`
`@@ -252,9 +250,8 @@ public interface HttpAsyncResponse {`
`252`	`250`	`* may not be available at the time of the callback. As such {@link RequestLogger}`
`253`	`251`	`* will not include response content in logging stream request/response.`
`254`	`252`	`* <p>`
`255`		`- * If the HTTP statusCode is 300 or above a HttpException is throw which contains`
`256`		`- * the HttpResponse. This is the cause in the CompletionException. Redirects are`
`257`		`- * by default followed apart from HTTPS to HTTP.`
	`253`	`+ * If the HTTP statusCode is not in the 2XX range a HttpException is throw which contains`
	`254`	`+ * the HttpResponse. This is the cause in the CompletionException.`
`258`	`255`	`*`
`259`	`256`	`* <pre>{@code`
`260`	`257`	`*`
Original file line number	Diff line number	Diff line change
`@@ -120,9 +120,8 @@ public interface HttpCallResponse {`
`120`	`120`	`/**`
`121`	`121`	`* A bean response to execute async or sync.`
`122`	`122`	`* <p>`
`123`		`- * If the HTTP statusCode is 300 or above a HttpException is throw which contains`
`124`		`- * the HttpResponse. This is the cause in the CompletionException. Redirects are`
`125`		`- * by default followed apart from HTTPS to HTTP.`
	`123`	`+ * If the HTTP statusCode is not in the 2XX range a HttpException is throw which contains`
	`124`	`+ * the HttpResponse. This is the cause in the CompletionException.`
`126`	`125`	`*`
`127`	`126`	`* <pre>{@code`
`128`	`127`	`*`
`@@ -142,9 +141,8 @@ public interface HttpCallResponse {`
`142`	`141`	`/**`
`143`	`142`	`* Process expecting a list of beans response body (typically from json content).`
`144`	`143`	`* <p>`
`145`		`- * If the HTTP statusCode is 300 or above a HttpException is throw which contains`
`146`		`- * the HttpResponse. This is the cause in the CompletionException. Redirects are`
`147`		`- * by default followed apart from HTTPS to HTTP.`
	`144`	`+ * If the HTTP statusCode is not in the 2XX range a HttpException is throw which contains`
	`145`	`+ * the HttpResponse. This is the cause in the CompletionException.`
`148`	`146`	`*`
`149`	`147`	`* <pre>{@code`
`150`	`148`	`*`
`@@ -163,9 +161,8 @@ public interface HttpCallResponse {`
`163`	`161`	`/**`
`164`	`162`	`* Process expecting a stream of beans response body (typically from json content).`
`165`	`163`	`* <p>`
`166`		`- * If the HTTP statusCode is 300 or above a HttpException is throw which contains`
`167`		`- * the HttpResponse. This is the cause in the CompletionException. Redirects are`
`168`		`- * by default followed apart from HTTPS to HTTP.`
	`164`	`+ * If the HTTP statusCode is not in the 2XX range a HttpException is throw which contains`
	`165`	`+ * the HttpResponse. This is the cause in the CompletionException.`
`169`	`166`	`*`
`170`	`167`	`* <pre>{@code`
`171`	`168`	`*`