#47 - Change method .withHandler() -> .handler() with deprecation

Author: rbygrave

README.md

@@ -118,21 +118,21 @@ Overview of response types for sync calls.
 <tr><td>bean&lt;E&gt</td><td>E</td></tr>
 <tr><td>list&lt;E&gt</td><td>List&lt;E&gt;</td></tr>
 <tr><td>stream&lt;E&gt</td><td>Stream&lt;E&gt;</td></tr>
-<tr><td>withHandler(HttpResponse.BodyHandler&lt;E&gt;)</td><td>HttpResponse&lt;E&gt;</td></tr>
+<tr><td>handler(HttpResponse.BodyHandler&lt;E&gt;)</td><td>HttpResponse&lt;E&gt;</td></tr>
 <tr><td>&nbsp;</td><td>&nbsp;</td></tr>
 <tr><td><b>async processing</b></td><td>&nbsp;</td></tr>
 <tr><td>asVoid</td><td>CompletableFuture&lt;HttpResponse&lt;Void&gt;&gt;</td></tr>
 <tr><td>asString</td><td>CompletableFuture&lt;HttpResponse&lt;String&gt;&gt;</td></tr>
 <tr><td>bean&lt;E&gt</td><td>CompletableFuture&lt;E&gt;</td></tr>
 <tr><td>list&lt;E&gt</td><td>CompletableFuture&lt;List&lt;E&gt;&gt;</td></tr>
 <tr><td>stream&lt;E&gt</td><td>CompletableFuture&lt;Stream&lt;E&gt;&gt;</td></tr>
-<tr><td>withHandler(HttpResponse.BodyHandler&lt;E&gt)</td><td>CompletableFuture&lt;HttpResponse&lt;E&gt;&gt;</td></tr>
+<tr><td>handler(HttpResponse.BodyHandler&lt;E&gt)</td><td>CompletableFuture&lt;HttpResponse&lt;E&gt;&gt;</td></tr>
 </table>
 
 ### HttpResponse BodyHandlers
 
 JDK HttpClient provides a number of [BodyHandlers](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.BodyHandler.html)
-including reactive Flow based subscribers. With the `withHandler()` method we can use any of these or our own [`HttpResponse.BodyHandler`](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.BodyHandler.html)
+including reactive Flow based subscribers. With the `handler()` method we can use any of these or our own [`HttpResponse.BodyHandler`](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.BodyHandler.html)
 implementation.
 
 Refer to [HttpResponse.BodyHandlers](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.BodyHandlers.html)
@@ -307,7 +307,7 @@ The `bean()`, `list()` and `stream()` responses throw a `HttpException` if the s
 <tr><td>bean&lt;E&gt</td><td>CompletableFuture&lt;E&gt;</td></tr>
 <tr><td>list&lt;E&gt</td><td>CompletableFuture&lt;List&lt;E&gt;&gt;</td></tr>
 <tr><td>stream&lt;E&gt</td><td>CompletableFuture&lt;Stream&lt;E&gt;&gt;</td></tr>
-<tr><td>withHandler(HttpResponse.BodyHandler&lt;E&gt)</td><td>CompletableFuture&lt;HttpResponse&lt;E&gt;&gt;</td></tr>
+<tr><td>handler(HttpResponse.BodyHandler&lt;E&gt)</td><td>CompletableFuture&lt;HttpResponse&lt;E&gt;&gt;</td></tr>
 </table>
 
 ### .async().asDiscarding() - HttpResponse&lt;Void&gt;
@@ -374,15 +374,15 @@ clientContext.request()
 
 ```
 
-### .async().withHandler(...) - Any `Response.BodyHandler` implementation
+### .async().handler(...) - Any `Response.BodyHandler` implementation
 
 The example below is a line subscriber processing response content line by line.
 
 ```java
 CompletableFuture<HttpResponse<Void>> future = clientContext.request()
    .path("hello/lineStream")
    .GET().async()
-   .withHandler(HttpResponse.BodyHandlers.fromLineSubscriber(new Flow.Subscriber<>() {
+   .handler(HttpResponse.BodyHandlers.fromLineSubscriber(new Flow.Subscriber<>() {
 
      @Override
      public void onSubscribe(Flow.Subscription subscription) {

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

@@ -21,7 +21,7 @@ private <E> CompletableFuture<HttpResponse<E>> with(boolean loggable, HttpRespon
   }
 
   @Override
-  public <E> CompletableFuture<HttpResponse<E>> withHandler(HttpResponse.BodyHandler<E>  handler) {
+  public <E> CompletableFuture<HttpResponse<E>> handler(HttpResponse.BodyHandler<E>  handler) {
     return with(false, handler);
   }
 

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

@@ -45,7 +45,7 @@ public HttpCall<HttpResponse<InputStream>> asInputStream() {
   }
 
   @Override
-  public <E> HttpCall<HttpResponse<E>> withHandler(HttpResponse.BodyHandler<E> bodyHandler) {
+  public <E> HttpCall<HttpResponse<E>> handler(HttpResponse.BodyHandler<E> bodyHandler) {
     return new CallHandler<>(bodyHandler);
   }
 
@@ -182,11 +182,11 @@ private class CallHandler<E> implements HttpCall<HttpResponse<E>> {
     }
     @Override
     public HttpResponse<E> execute() {
-      return request.withHandler(handler);
+      return request.handler(handler);
     }
     @Override
     public CompletableFuture<HttpResponse<E>> async() {
-      return request.async().withHandler(handler);
+      return request.async().handler(handler);
     }
   }
 }

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

@@ -436,7 +436,7 @@ public <T> List<T> list(Class<T> cls) {
 
   @Override
   public <T> Stream<T> stream(Class<T> cls) {
-    final HttpResponse<Stream<String>> res = withHandler(HttpResponse.BodyHandlers.ofLines());
+    final HttpResponse<Stream<String>> res = handler(HttpResponse.BodyHandlers.ofLines());
     this.httpResponse = res;
     if (res.statusCode() >= 300) {
       throw new HttpException(res, context);
@@ -446,7 +446,7 @@ public <T> Stream<T> stream(Class<T> cls) {
   }
 
   @Override
-  public <T> HttpResponse<T> withHandler(HttpResponse.BodyHandler<T> responseHandler) {
+  public <T> HttpResponse<T> handler(HttpResponse.BodyHandler<T> responseHandler) {
     final HttpResponse<T> response = sendWith(responseHandler);
     context.afterResponse(this);
     return response;
@@ -528,7 +528,7 @@ public long responseTimeMicros() {
 
   @Override
   public HttpResponse<byte[]> asByteArray() {
-    return withHandler(HttpResponse.BodyHandlers.ofByteArray());
+    return handler(HttpResponse.BodyHandlers.ofByteArray());
   }
 
   private HttpResponse<String> addMetrics(final HttpResponse<String> res) {
@@ -539,35 +539,35 @@ private HttpResponse<String> addMetrics(final HttpResponse<String> res) {
   @Override
   public HttpResponse<String> asString() {
     loggableResponseBody = true;
-    return addMetrics(withHandler(HttpResponse.BodyHandlers.ofString()));
+    return addMetrics(handler(HttpResponse.BodyHandlers.ofString()));
   }
 
   @Override
   public HttpResponse<String> asPlainString() {
     loggableResponseBody = true;
-    final HttpResponse<String> hres = addMetrics(withHandler(HttpResponse.BodyHandlers.ofString()));
+    final HttpResponse<String> hres = addMetrics(handler(HttpResponse.BodyHandlers.ofString()));
     context.checkResponse(hres);
     return hres;
   }
 
   @Override
   public HttpResponse<Void> asDiscarding() {
-    return withHandler(discarding());
+    return handler(discarding());
   }
 
   @Override
   public HttpResponse<InputStream> asInputStream() {
-    return withHandler(HttpResponse.BodyHandlers.ofInputStream());
+    return handler(HttpResponse.BodyHandlers.ofInputStream());
   }
 
   @Override
   public HttpResponse<Path> asFile(Path file) {
-    return withHandler(HttpResponse.BodyHandlers.ofFile(file));
+    return handler(HttpResponse.BodyHandlers.ofFile(file));
   }
 
   @Override
   public HttpResponse<Stream<String>> asLines() {
-    return withHandler(HttpResponse.BodyHandlers.ofLines());
+    return handler(HttpResponse.BodyHandlers.ofLines());
   }
 
   private HttpRequest.Builder newReq(String url) {

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

@@ -193,7 +193,7 @@ public interface HttpAsyncResponse {
    *    CompletableFuture<HttpResponse<Void>> future = clientContext.request()
    *       .path("hello/lineStream")
    *       .GET().async()
-   *       .withHandler(HttpResponse.BodyHandlers.fromLineSubscriber(new Flow.Subscriber<>() {
+   *       .handler(HttpResponse.BodyHandlers.fromLineSubscriber(new Flow.Subscriber<>() {
    *
    *         @Override
    *         public void onSubscribe(Flow.Subscription subscription) {
@@ -221,7 +221,15 @@ public interface HttpAsyncResponse {
    * @param bodyHandler The body handler to use to process the response
    * @return The CompletableFuture of the response
    */
-  <E> CompletableFuture<HttpResponse<E>> withHandler(HttpResponse.BodyHandler<E> bodyHandler);
+  <E> CompletableFuture<HttpResponse<E>> handler(HttpResponse.BodyHandler<E> bodyHandler);
+
+  /**
+   * Deprecated - migrate to handler().
+   */
+  @Deprecated
+  default <E> CompletableFuture<HttpResponse<E>> withHandler(HttpResponse.BodyHandler<E> bodyHandler) {
+    return handler(bodyHandler);
+  }
 
   /**
    * Process expecting a bean response body (typically from json content).

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

@@ -109,13 +109,21 @@ public interface HttpCallResponse {
    *    HttpCall<E> call = clientContext.request()
    *       .path("hello/lineStream")
    *       .GET()
-   *       .call().withHandler(HttpResponse.BodyHandler<E> ...);
+   *       .call().handler(HttpResponse.BodyHandler<E> ...);
    * }</pre>
    *
    * @param bodyHandler The response body handler to use
    * @return The HttpCall to allow sync or async execution
    */
-  <E> HttpCall<HttpResponse<E>> withHandler(HttpResponse.BodyHandler<E> bodyHandler);
+  <E> HttpCall<HttpResponse<E>> handler(HttpResponse.BodyHandler<E> bodyHandler);
+
+  /**
+   * Deprecated - migrate to handler().
+   */
+  @Deprecated
+  default <E> HttpCall<HttpResponse<E>> withHandler(HttpResponse.BodyHandler<E> bodyHandler) {
+    return handler(bodyHandler);
+  }
 
   /**
    * A bean response to execute async or sync.

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

@@ -167,6 +167,14 @@ public interface HttpClientResponse {
   /**
    * Return the response using the given response body handler.
    */
-  <T> HttpResponse<T> withHandler(HttpResponse.BodyHandler<T> responseHandler);
+  <T> HttpResponse<T> handler(HttpResponse.BodyHandler<T> responseHandler);
+
+  /**
+   * Deprecated - migrate to handler().
+   */
+  @Deprecated
+  default <T> HttpResponse<T> withHandler(HttpResponse.BodyHandler<T> responseHandler) {
+    return handler(responseHandler);
+  }
 
 }

client/src/test/java/io/avaje/http/client/HelloControllerTest.java

@@ -307,7 +307,7 @@ void async_stream_fromLineSubscriber() throws ExecutionException, InterruptedExc
     final CompletableFuture<HttpResponse<Void>> future = clientContext.request()
       .path("hello/stream")
       .GET()
-      .async().withHandler(HttpResponse.BodyHandlers.fromLineSubscriber(new Flow.Subscriber<>() {
+      .async().handler(HttpResponse.BodyHandlers.fromLineSubscriber(new Flow.Subscriber<>() {
         @Override
         public void onSubscribe(Flow.Subscription subscription) {
           subscription.request(Long.MAX_VALUE);
@@ -545,10 +545,10 @@ void callBytesAsync() throws ExecutionException, InterruptedException {
   }
 
   @Test
-  void callWithHandler() {
+  void callHandler() {
     final HttpResponse<String> hres = clientContext.request()
       .path("hello").path("message")
-      .GET().call().withHandler(HttpResponse.BodyHandlers.ofString())
+      .GET().call().handler(HttpResponse.BodyHandlers.ofString())
       .execute();
 
     assertThat(hres.body()).contains("hello world");
@@ -559,7 +559,7 @@ void callWithHandler() {
   void callWithHandlerAsync() throws ExecutionException, InterruptedException {
     final HttpResponse<String> hres = clientContext.request()
       .path("hello").path("message")
-      .GET().call().withHandler(HttpResponse.BodyHandlers.ofString())
+      .GET().call().handler(HttpResponse.BodyHandlers.ofString())
       .async().get();
 
     assertThat(hres.body()).contains("hello world");

client/src/test/java/org/example/github/httpclient/Simple$HttpClient.java

@@ -56,7 +56,7 @@ public InputStream getById2(String id, InputStream is) {
       context.request()
         .path("users").path(id).path("stream")
         .body(() -> is)
-        .GET().withHandler(HttpResponse.BodyHandlers.ofInputStream());
+        .GET().handler(HttpResponse.BodyHandlers.ofInputStream());
 
     context.checkResponse(response);
     return response.body();