#46 - Change method .newBuilder() -> .builder() with deprecation

rbygrave · rbygrave · commit 7e33fe55c49f · 2022-05-05T08:51:11.000+12:00
diff --git a/README.md b/README.md
@@ -35,10 +35,11 @@ Create a HttpClientContext with a baseUrl, Jackson or Gson based JSON
 
 ```java
   public HttpClientContext client() {
-    return HttpClientContext.newBuilder()
-      .withBaseUrl(baseUrl)
-      .withBodyAdapter(new JacksonBodyAdapter(new ObjectMapper()))
-//      .withBodyAdapter(new GsonBodyAdapter(new Gson()))
+    return HttpClientContext.builder()
+      .baseUrl(baseUrl)
+      .bodyAdapter(new JsonbBodyAdapter())
+      //.bodyAdapter(new JacksonBodyAdapter(new ObjectMapper()))
+      //.bodyAdapter(new GsonBodyAdapter(new Gson()))
       .build();
   }
 
@@ -443,10 +444,10 @@ header ("Basic Auth").
 
 ```java
 HttpClientContext clientContext =
-   HttpClientContext.newBuilder()
-     .withBaseUrl(baseUrl)
+   HttpClientContext.builder()
+     .baseUrl(baseUrl)
      ...
-     .withRequestIntercept(new BasicAuthIntercept("myUsername", "myPassword"))  <!-- HERE
+     .requestIntercept(new BasicAuthIntercept("myUsername", "myPassword"))  <!-- HERE
      .build();
 ```
 
@@ -481,10 +482,10 @@ and register that when building the HttpClientContext.
 ### 2. Register with HttpClientContext
 
 ```java
-    HttpClientContext ctx = HttpClientContext.newBuilder()
-      .withBaseUrl("https://foo")
+    HttpClientContext ctx = HttpClientContext.builder()
+      .baseUrl("https://foo")
       ...
-      .withAuthTokenProvider(new MyAuthTokenProvider()) <!-- HERE
+      .authTokenProvider(new MyAuthTokenProvider()) <!-- HERE
       .build();
 ```
 
diff --git a/client/src/main/java/io/avaje/http/client/DHttpClientContextBuilder.java b/client/src/main/java/io/avaje/http/client/DHttpClientContextBuilder.java
@@ -156,7 +156,7 @@ public HttpClientContext build() {
       client = defaultClient();
     }
     if (requestLogging) {
-      // register the built in request/response logging
+      // register the builtin request/response logging
       requestListener(new RequestLogger());
     }
     return new DHttpClientContext(client, baseUrl, requestTimeout, bodyAdapter, retryHandler, buildListener(), authTokenProvider, buildIntercept());
diff --git a/client/src/main/java/io/avaje/http/client/HttpClientContext.java b/client/src/main/java/io/avaje/http/client/HttpClientContext.java
@@ -15,7 +15,7 @@
  *
  * <pre>{@code
  *
- *   HttpClientContext ctx = HttpClientContext.newBuilder()
+ *   HttpClientContext ctx = HttpClientContext.builder()
  *       .baseUrl("http://localhost:8080")
  *       .bodyAdapter(new JacksonBodyAdapter())
  *       .build();
@@ -36,7 +36,7 @@ public interface HttpClientContext {
    *
    * <pre>{@code
    *
-   *   HttpClientContext ctx = HttpClientContext.newBuilder()
+   *   HttpClientContext ctx = HttpClientContext.builder()
    *       .baseUrl("http://localhost:8080")
    *       .bodyAdapter(new JacksonBodyAdapter())
    *       .build();
@@ -47,10 +47,18 @@ public interface HttpClientContext {
    *
    * }</pre>
    */
-  static HttpClientContext.Builder newBuilder() {
+  static HttpClientContext.Builder builder() {
     return new DHttpClientContextBuilder();
   }
 
+  /**
+   * Deprecated - migrate to builder().
+   */
+  @Deprecated
+  static HttpClientContext.Builder newBuilder() {
+    return builder();
+  }
+
   /**
    * Return the http client API implementation.
    *
@@ -134,7 +142,7 @@ static HttpClientContext.Builder newBuilder() {
    *
    * <pre>{@code
    *
-   *   HttpClientContext ctx = HttpClientContext.newBuilder()
+   *   HttpClientContext ctx = HttpClientContext.builder()
    *       .baseUrl("http://localhost:8080")
    *       .bodyAdapter(new JacksonBodyAdapter())
    *       .build();
@@ -308,7 +316,7 @@ interface Builder {
      *
      * <pre>{@code
      *
-     *   HttpClientContext ctx = HttpClientContext.newBuilder()
+     *   HttpClientContext ctx = HttpClientContext.builder()
      *       .baseUrl("http://localhost:8080")
      *       .bodyAdapter(new JacksonBodyAdapter())
      *       .build();
diff --git a/client/src/main/java/io/avaje/http/client/JacksonBodyAdapter.java b/client/src/main/java/io/avaje/http/client/JacksonBodyAdapter.java
@@ -15,7 +15,7 @@
  *
  * <pre>{@code
  *
- *   HttpClientContext.newBuilder()
+ *   HttpClientContext.builder()
  *       .baseUrl(baseUrl)
  *       .bodyAdapter(new JacksonBodyAdapter())
  *       .build();
diff --git a/client/src/main/java/io/avaje/http/client/JsonbBodyAdapter.java b/client/src/main/java/io/avaje/http/client/JsonbBodyAdapter.java
@@ -11,7 +11,7 @@
  *
  * <pre>{@code
  *
- *   HttpClientContext.newBuilder()
+ *   HttpClientContext.builder()
  *       .baseUrl(baseUrl)
  *       .bodyAdapter(new JsonbBodyAdapter())
  *       .build();
diff --git a/client/src/main/java/io/avaje/http/client/package-info.java b/client/src/main/java/io/avaje/http/client/package-info.java
@@ -6,7 +6,7 @@
  *
  * <pre>{@code
  *
- *   HttpClientContext ctx = HttpClientContext.newBuilder()
+ *   HttpClientContext ctx = HttpClientContext.builder()
  *       .baseUrl("http://localhost:8080")
  *       .bodyAdapter(new JacksonBodyAdapter())
  *       .build();
diff --git a/client/src/test/java/io/avaje/http/client/AuthTokenTest.java b/client/src/test/java/io/avaje/http/client/AuthTokenTest.java
@@ -45,7 +45,7 @@ public AuthToken obtainToken(HttpClientRequest tokenRequest) {
   @Test
   void sendEmail() {
 
-    HttpClientContext ctx = HttpClientContext.newBuilder()
+    HttpClientContext ctx = HttpClientContext.builder()
       .baseUrl("https://foo")
       .bodyAdapter(new JacksonBodyAdapter(objectMapper))
       .authTokenProvider(new MyAuthTokenProvider())
diff --git a/client/src/test/java/io/avaje/http/client/BaseWebTest.java b/client/src/test/java/io/avaje/http/client/BaseWebTest.java
@@ -24,7 +24,7 @@ public static void shutdown() {
   }
 
   public static HttpClientContext client() {
-    return HttpClientContext.newBuilder()
+    return HttpClientContext.builder()
       .baseUrl(baseUrl)
       .bodyAdapter(new JacksonBodyAdapter(new ObjectMapper()))
       .build();
diff --git a/client/src/test/java/io/avaje/http/client/BasicAuthInterceptTest.java b/client/src/test/java/io/avaje/http/client/BasicAuthInterceptTest.java
@@ -18,7 +18,7 @@ void encode() {
   void beforeRequest() {
     // setup
     final BasicAuthIntercept intercept = new BasicAuthIntercept("Aladdin", "open sesame");
-    final HttpClientContext ctx = HttpClientContext.newBuilder().baseUrl("junk").build();
+    final HttpClientContext ctx = HttpClientContext.builder().baseUrl("junk").build();
 
     // act
     final HttpClientRequest request = ctx.request();
diff --git a/client/src/test/java/io/avaje/http/client/DHttpApiTest.java b/client/src/test/java/io/avaje/http/client/DHttpApiTest.java
@@ -18,7 +18,7 @@ public class DHttpApiTest {
   @Test
   void test_github_listRepos() {
 
-    final HttpClientContext clientContext = HttpClientContext.newBuilder()
+    final HttpClientContext clientContext = HttpClientContext.builder()
       .baseUrl("https://api.github.com")
       .bodyAdapter(new JacksonBodyAdapter())
       .build();
@@ -39,7 +39,7 @@ void jsonb_github_listRepos() {
       //.adapter(new JacksonAdapter())
       .build();
 
-    final HttpClientContext clientContext = HttpClientContext.newBuilder()
+    final HttpClientContext clientContext = HttpClientContext.builder()
       .baseUrl("https://api.github.com")
       .bodyAdapter(new JsonbBodyAdapter(jsonb))
       .build();
diff --git a/client/src/test/java/io/avaje/http/client/DHttpClientContextTest.java b/client/src/test/java/io/avaje/http/client/DHttpClientContextTest.java
@@ -41,7 +41,7 @@ void gzip_contentDecode() {
   void build_basic() {
 
     final HttpClientContext context =
-      HttpClientContext.newBuilder()
+      HttpClientContext.builder()
       .baseUrl("http://localhost")
       .build();
 
@@ -60,7 +60,7 @@ void build_basic() {
   void build_noCookieHandler() {
 
     final HttpClientContext context =
-      HttpClientContext.newBuilder()
+      HttpClientContext.builder()
         .baseUrl("http://localhost")
         .cookieHandler(null)
         .redirect(HttpClient.Redirect.ALWAYS)
@@ -80,7 +80,7 @@ void build_noCookieHandler() {
   @Test
   void build_missingBaseUrl() {
     try {
-      HttpClientContext.newBuilder().build();
+      HttpClientContext.builder().build();
     } catch (NullPointerException e) {
       assertThat(e.getMessage()).contains("baseUrl is not specified");
     }
diff --git a/client/src/test/java/io/avaje/http/client/HelloBasicAuthTest.java b/client/src/test/java/io/avaje/http/client/HelloBasicAuthTest.java
@@ -12,7 +12,7 @@ class HelloBasicAuthTest extends BaseWebTest {
   final HttpClientContext clientContext = client();
 
   public static HttpClientContext client() {
-    return HttpClientContext.newBuilder()
+    return HttpClientContext.builder()
       .baseUrl(baseUrl)
       .bodyAdapter(new JacksonBodyAdapter(new ObjectMapper()))
       .requestIntercept(new BasicAuthIntercept("rob", "bot"))
diff --git a/client/src/test/java/io/avaje/http/client/RequestListenerTest.java b/client/src/test/java/io/avaje/http/client/RequestListenerTest.java
@@ -1,6 +1,5 @@
 package io.avaje.http.client;
 
-import com.fasterxml.jackson.databind.ObjectMapper;
 import org.junit.jupiter.api.Test;
 
 import java.net.http.HttpResponse;
@@ -34,7 +33,7 @@ public void response(Event event) {
   }
 
   private HttpClientContext createClient(TDRequestListener tdRequestListener) {
-    return HttpClientContext.newBuilder()
+    return HttpClientContext.builder()
       .baseUrl(baseUrl)
       .requestLogging(false)
       .requestListener(new RequestLogger())
diff --git a/client/src/test/java/io/avaje/http/client/RetryTest.java b/client/src/test/java/io/avaje/http/client/RetryTest.java
@@ -10,7 +10,7 @@ class RetryTest extends BaseWebTest {
 
 
   HttpClientContext initClientWithRetry(MyIntercept myIntercept, RetryHandler retryHandler) {
-    return HttpClientContext.newBuilder()
+    return HttpClientContext.builder()
       .baseUrl("http://localhost:8887")
       .bodyAdapter(new JacksonBodyAdapter())
       .retryHandler(retryHandler)
diff --git a/client/src/test/java/org/example/github/GithubTest.java b/client/src/test/java/org/example/github/GithubTest.java
@@ -15,7 +15,7 @@ public class GithubTest {
   @Disabled
   void test() {
 
-    final HttpClientContext clientContext = HttpClientContext.newBuilder()
+    final HttpClientContext clientContext = HttpClientContext.builder()
       .baseUrl("https://api.github.com")
       .bodyAdapter(new JacksonBodyAdapter())
       .requestLogging(false)
diff --git a/gson-adapter/src/main/java/io/avaje/http/client/gson/GsonBodyAdapter.java b/gson-adapter/src/main/java/io/avaje/http/client/gson/GsonBodyAdapter.java
@@ -21,11 +21,11 @@
  *
  * <pre>{@code
  *
- *   HttpClientContext.newBuilder()
- *       .withBaseUrl(baseUrl)
- *       .withRequestListener(new RequestLogger())
- *       //.withBodyAdapter(new JacksonBodyAdapter(new ObjectMapper()))
- *       .withBodyAdapter(new GsonBodyAdapter(new Gson()))
+ *   HttpClientContext.builder()
+ *       .baseUrl(baseUrl)
+ *       .requestListener(new RequestLogger())
+ *       //.bodyAdapter(new JacksonBodyAdapter(new ObjectMapper()))
+ *       .bodyAdapter(new GsonBodyAdapter(new Gson()))
  *       .build();
  *
  * }</pre>
diff --git a/test/src/test/java/example/github/GithubTest.java b/test/src/test/java/example/github/GithubTest.java
@@ -24,7 +24,7 @@ void test_with_gson() {
   }
 
   private void assertListRepos(BodyAdapter bodyAdapter) {
-    final HttpClientContext clientContext = HttpClientContext.newBuilder()
+    final HttpClientContext clientContext = HttpClientContext.builder()
       .baseUrl("https://api.github.com")
       .bodyAdapter(bodyAdapter)
 //      .requestLogging(false)

Original file line number	Diff line number	Diff line change
`@@ -156,7 +156,7 @@ public HttpClientContext build() {`
`156`	`156`	`client = defaultClient();`
`157`	`157`	`}`
`158`	`158`	`if (requestLogging) {`
`159`		`- // register the built in request/response logging`
	`159`	`+ // register the builtin request/response logging`
`160`	`160`	`requestListener(new RequestLogger());`
`161`	`161`	`}`
`162`	`162`	`return new DHttpClientContext(client, baseUrl, requestTimeout, bodyAdapter, retryHandler, buildListener(), authTokenProvider, buildIntercept());`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@`
`15`	`15`	`*`
`16`	`16`	`* <pre>{@code`
`17`	`17`	`*`
`18`		`- * HttpClientContext ctx = HttpClientContext.newBuilder()`
	`18`	`+ * HttpClientContext ctx = HttpClientContext.builder()`
`19`	`19`	`* .baseUrl("http://localhost:8080")`
`20`	`20`	`* .bodyAdapter(new JacksonBodyAdapter())`
`21`	`21`	`* .build();`
`@@ -36,7 +36,7 @@ public interface HttpClientContext {`
`36`	`36`	`*`
`37`	`37`	`* <pre>{@code`
`38`	`38`	`*`
`39`		`- * HttpClientContext ctx = HttpClientContext.newBuilder()`
	`39`	`+ * HttpClientContext ctx = HttpClientContext.builder()`
`40`	`40`	`* .baseUrl("http://localhost:8080")`
`41`	`41`	`* .bodyAdapter(new JacksonBodyAdapter())`
`42`	`42`	`* .build();`
`@@ -47,10 +47,18 @@ public interface HttpClientContext {`
`47`	`47`	`*`
`48`	`48`	`* }</pre>`
`49`	`49`	`*/`
`50`		`- static HttpClientContext.Builder newBuilder() {`
	`50`	`+ static HttpClientContext.Builder builder() {`
`51`	`51`	`return new DHttpClientContextBuilder();`
`52`	`52`	`}`
`53`	`53`
	`54`	`+ /**`
	`55`	`+ * Deprecated - migrate to builder().`
	`56`	`+ */`
	`57`	`+ @Deprecated`
	`58`	`+ static HttpClientContext.Builder newBuilder() {`
	`59`	`+ return builder();`
	`60`	`+ }`
	`61`	`+`
`54`	`62`	`/**`
`55`	`63`	`* Return the http client API implementation.`
`56`	`64`	`*`
`@@ -134,7 +142,7 @@ static HttpClientContext.Builder newBuilder() {`
`134`	`142`	`*`
`135`	`143`	`* <pre>{@code`
`136`	`144`	`*`
`137`		`- * HttpClientContext ctx = HttpClientContext.newBuilder()`
	`145`	`+ * HttpClientContext ctx = HttpClientContext.builder()`
`138`	`146`	`* .baseUrl("http://localhost:8080")`
`139`	`147`	`* .bodyAdapter(new JacksonBodyAdapter())`
`140`	`148`	`* .build();`
`@@ -308,7 +316,7 @@ interface Builder {`
`308`	`316`	`*`
`309`	`317`	`* <pre>{@code`
`310`	`318`	`*`
`311`		`- * HttpClientContext ctx = HttpClientContext.newBuilder()`
	`319`	`+ * HttpClientContext ctx = HttpClientContext.builder()`
`312`	`320`	`* .baseUrl("http://localhost:8080")`
`313`	`321`	`* .bodyAdapter(new JacksonBodyAdapter())`
`314`	`322`	`* .build();`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`	`*`
`12`	`12`	`* <pre>{@code`
`13`	`13`	`*`
`14`		`- * HttpClientContext.newBuilder()`
	`14`	`+ * HttpClientContext.builder()`
`15`	`15`	`* .baseUrl(baseUrl)`
`16`	`16`	`* .bodyAdapter(new JsonbBodyAdapter())`
`17`	`17`	`* .build();`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`*`
`7`	`7`	`* <pre>{@code`
`8`	`8`	`*`
`9`		`- * HttpClientContext ctx = HttpClientContext.newBuilder()`
	`9`	`+ * HttpClientContext ctx = HttpClientContext.builder()`
`10`	`10`	`* .baseUrl("http://localhost:8080")`
`11`	`11`	`* .bodyAdapter(new JacksonBodyAdapter())`
`12`	`12`	`* .build();`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ public static void shutdown() {`
`24`	`24`	`}`
`25`	`25`
`26`	`26`	`public static HttpClientContext client() {`
`27`		`- return HttpClientContext.newBuilder()`
	`27`	`+ return HttpClientContext.builder()`
`28`	`28`	`.baseUrl(baseUrl)`
`29`	`29`	`.bodyAdapter(new JacksonBodyAdapter(new ObjectMapper()))`
`30`	`30`	`.build();`