Javadoc update

Author: rbygrave

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

@@ -13,14 +13,15 @@
  *
  *   HttpClientContext ctx = HttpClientContext.newBuilder()
  *       .withBaseUrl("http://localhost:8080")
+ *       .withRequestListener(new RequestLogger())
  *       .withBodyAdapter(new JacksonBodyAdapter(new ObjectMapper()))
  *       .build();
  *
  *  HelloDto dto = ctx.request()
  *       .path("hello")
  *       .queryParam("name", "Rob")
  *       .queryParam("say", "Ki ora")
- *       .get()
+ *       .GET()
  *       .bean(HelloDto.class);
  *
  * }</pre>
@@ -34,12 +35,13 @@ public interface HttpClientContext {
    *
    *   HttpClientContext ctx = HttpClientContext.newBuilder()
    *       .withBaseUrl("http://localhost:8080")
+   *       .withRequestListener(new RequestLogger())
    *       .withBodyAdapter(new JacksonBodyAdapter(new ObjectMapper()))
    *       .build();
    *
    *  HttpResponse<String> res = ctx.request()
    *       .path("hello")
-   *       .get().asString();
+   *       .GET().asString();
    *
    * }</pre>
    */
@@ -118,14 +120,15 @@ static HttpClientContext.Builder newBuilder() {
    *
    *   HttpClientContext ctx = HttpClientContext.newBuilder()
    *       .withBaseUrl("http://localhost:8080")
+   *       .withRequestListener(new RequestLogger())
    *       .withBodyAdapter(new JacksonBodyAdapter(new ObjectMapper()))
    *       .build();
    *
    *  HelloDto dto = ctx.request()
    *       .path("hello")
    *       .queryParam("name", "Rob")
    *       .queryParam("say", "Ki ora")
-   *       .get()
+   *       .GET()
    *       .bean(HelloDto.class);
    *
    * }</pre>
@@ -227,13 +230,14 @@ interface Builder {
      *
      *   HttpClientContext ctx = HttpClientContext.newBuilder()
      *       .withBaseUrl("http://localhost:8080")
+     *       .withRequestListener(new RequestLogger())
      *       .withBodyAdapter(new JacksonBodyAdapter(new ObjectMapper()))
      *       .build();
      *
      *  HelloDto dto = ctx.request()
      *       .path("hello")
      *       .queryParam("say", "Ki ora")
-     *       .get()
+     *       .GET()
      *       .bean(HelloDto.class);
      *
      * }</pre>

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

@@ -19,7 +19,8 @@
  *
  *  HelloDto dto = clientContext.request()
  *       .path("hello").queryParam("name", "Rob").queryParam("say", "Ki ora")
- *       .get().bean(HelloDto.class);
+ *       .GET()
+ *       .bean(HelloDto.class);
  *
  * }</pre>
  *
@@ -92,7 +93,8 @@ public interface HttpClientRequest {
    *  HttpResponse<String> res = clientContext.request()
    *       .url("http://127.0.0.1:8887")
    *       .path("hello")
-   *       .get().asString();
+   *       .GET()
+   *       .asString();
    *
    * }</pre>
    *

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

@@ -12,17 +12,27 @@
 
 /**
  * Logs request and response details for debug logging purposes.
+ * <p>
+ * This implementation logs the request and response with the same
+ * single logging entry rather than separate logging of the request
+ * and response.
  */
 public class RequestLogger implements RequestListener {
 
   private static final Logger log = LoggerFactory.getLogger(RequestLogger.class);
 
   private final String delimiter;
 
+  /**
+   * Create using the {@literal \n} new line character.
+   */
   public RequestLogger() {
     this("\n");
   }
 
+  /**
+   * Create with a given line delimiter.
+   */
   public RequestLogger(String delimiter) {
     this.delimiter = delimiter;
   }

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

@@ -15,6 +15,12 @@ public class SimpleRetryHandler implements RetryHandler {
   private final int maxRetries;
   private final long backoffMillis;
 
+  /**
+   * Create with maximum number of retries and linear backoff time.
+   *
+   * @param maxRetries    The maximum number of retry attempts
+   * @param backoffMillis The linear backoff between attempts in milliseconds
+   */
   public SimpleRetryHandler(int maxRetries, long backoffMillis) {
     this.maxRetries = maxRetries;
     this.backoffMillis = backoffMillis;

client/src/main/java/io/avaje/http/client/package-info.java

@@ -14,7 +14,7 @@
  *  HelloDto dto = ctx.request()
  *       .path("hello")
  *       .queryParam("say", "Ki ora")
- *       .get()
+ *       .GET()
  *       .bean(HelloDto.class);
  *
  * }</pre>