Minor cleanups (#1899)

Author: hyperxpro

client/src/main/java/org/asynchttpclient/AsyncCompletionHandler.java

@@ -98,7 +98,7 @@ public State onHeadersWritten() {
     }
 
     /**
-     * Invoked when the content (a {@link File}, {@link String} or
+     * Invoked when the content (a {@link File}, {@link String}) or
      * {@link InputStream} has been fully written on the I/O socket.
      *
      * @return a {@link AsyncHandler.State} telling to CONTINUE

client/src/main/java/org/asynchttpclient/AsyncHandler.java

@@ -54,7 +54,7 @@
  * <p>
  * Do NOT perform any blocking operations in any of these methods. A typical example would be trying to send another
  * request and calling get() on its future.
- * There's a chance you might end up in a dead lock.
+ * There's a chance you might end up in a deadlock.
  * If you really need to perform a blocking operation, execute it in a different dedicated thread pool.
  *
  * @param <T> Type of object returned by the {@link Future#get}
@@ -151,7 +151,7 @@ default void onHostnameResolutionFailure(String name, Throwable cause) {
     /**
      * Notify the callback when trying to open a new connection.
      * <p>
-     * Might be called several times if the name was resolved to multiple addresses and we failed to connect to the first(s) one(s).
+     * Might be called several times if the name was resolved to multiple addresses, and we failed to connect to the first(s) one(s).
      *
      * @param remoteAddress the address we try to connect to
      */

client/src/main/java/org/asynchttpclient/AsyncHttpClient.java

@@ -66,7 +66,7 @@
  * The {@link AsyncCompletionHandler#onCompleted(Response)} method will be invoked once the http response has been fully read.
  * The {@link Response} object includes the http headers and the response body. Note that the entire response will be buffered in memory.
  * <br>
- * You can also have more control about the how the response is asynchronously processed by using an {@link AsyncHandler}
+ * You can also have more control about how the response is asynchronously processed by using an {@link AsyncHandler}
  * <blockquote><pre>
  *      AsyncHttpClient c = new AsyncHttpClient();
  *      Future&lt;String&gt; f = c.prepareGet(TARGET_URL).execute(new AsyncHandler&lt;String&gt;() &#123;
@@ -149,7 +149,7 @@ public interface AsyncHttpClient extends Closeable {
      * Prepare an HTTP client request.
      *
      * @param method HTTP request method type. MUST BE in upper case
-     * @param url    A well formed URL.
+     * @param url    A well-formed URL.
      * @return {@link RequestBuilder}
      */
     BoundRequestBuilder prepare(String method, String url);
@@ -158,71 +158,71 @@ public interface AsyncHttpClient extends Closeable {
     /**
      * Prepare an HTTP client GET request.
      *
-     * @param url A well formed URL.
+     * @param url A well-formed URL.
      * @return {@link RequestBuilder}
      */
     BoundRequestBuilder prepareGet(String url);
 
     /**
      * Prepare an HTTP client CONNECT request.
      *
-     * @param url A well formed URL.
+     * @param url A well-formed URL.
      * @return {@link RequestBuilder}
      */
     BoundRequestBuilder prepareConnect(String url);
 
     /**
      * Prepare an HTTP client OPTIONS request.
      *
-     * @param url A well formed URL.
+     * @param url A well-formed URL.
      * @return {@link RequestBuilder}
      */
     BoundRequestBuilder prepareOptions(String url);
 
     /**
      * Prepare an HTTP client HEAD request.
      *
-     * @param url A well formed URL.
+     * @param url A well-formed URL.
      * @return {@link RequestBuilder}
      */
     BoundRequestBuilder prepareHead(String url);
 
     /**
      * Prepare an HTTP client POST request.
      *
-     * @param url A well formed URL.
+     * @param url A well-formed URL.
      * @return {@link RequestBuilder}
      */
     BoundRequestBuilder preparePost(String url);
 
     /**
      * Prepare an HTTP client PUT request.
      *
-     * @param url A well formed URL.
+     * @param url A well-formed URL.
      * @return {@link RequestBuilder}
      */
     BoundRequestBuilder preparePut(String url);
 
     /**
      * Prepare an HTTP client DELETE request.
      *
-     * @param url A well formed URL.
+     * @param url A well-formed URL.
      * @return {@link RequestBuilder}
      */
     BoundRequestBuilder prepareDelete(String url);
 
     /**
      * Prepare an HTTP client PATCH request.
      *
-     * @param url A well formed URL.
+     * @param url A well-formed URL.
      * @return {@link RequestBuilder}
      */
     BoundRequestBuilder preparePatch(String url);
 
     /**
      * Prepare an HTTP client TRACE request.
      *
-     * @param url A well formed URL.
+     * @param url A well-formed URL.
      * @return {@link RequestBuilder}
      */
     BoundRequestBuilder prepareTrace(String url);

client/src/main/java/org/asynchttpclient/AsyncHttpClientConfig.java

@@ -231,7 +231,7 @@ public interface AsyncHttpClientConfig {
     boolean isDisableUrlEncodingForBoundRequests();
 
     /**
-     * @return true if AHC is to use a LAX cookie encoder, eg accept illegal chars in cookie value
+     * @return true if AHC is to use a LAX cookie encoder, e.g. accept illegal chars in cookie value
      */
     boolean isUseLaxCookieEncoder();
 

client/src/main/java/org/asynchttpclient/ClientStats.java

@@ -20,7 +20,7 @@
 import java.util.Objects;
 
 /**
- * A record class representing the state of an (@link org.asynchttpclient.AsyncHttpClient).
+ * A record class representing the state of a (@link org.asynchttpclient.AsyncHttpClient).
  */
 public class ClientStats {
 

client/src/main/java/org/asynchttpclient/DefaultAsyncHttpClient.java

@@ -25,7 +25,7 @@
 import org.asynchttpclient.cookie.CookieEvictionTask;
 import org.asynchttpclient.cookie.CookieStore;
 import org.asynchttpclient.filter.FilterContext;
-import org.asynchttpclient.filter.FilterException;
+import org.asynchttpclient.exception.FilterException;
 import org.asynchttpclient.filter.RequestFilter;
 import org.asynchttpclient.handler.resumable.ResumableAsyncHandler;
 import org.asynchttpclient.netty.channel.ChannelManager;

client/src/main/java/org/asynchttpclient/DefaultAsyncHttpClientConfig.java

@@ -978,7 +978,7 @@ public Builder setStrict302Handling(final boolean strict302Handling) {
 
         /**
          * If true, AHC will  add Accept-Encoding HTTP header to each request
-         *
+         * <p>
          * If false (default), AHC will either leave AcceptEncoding header as is
          * (if enableAutomaticDecompression is false) or will remove unsupported
          * algorithms (if enableAutomaticDecompression is true)
@@ -988,7 +988,6 @@ public Builder setCompressionEnforced(boolean compressionEnforced) {
             return this;
         }
 
-
         /*
          * If true (default), AHC will add a Netty HttpContentDecompressor, so compressed
          * content will automatically get decompressed.
@@ -997,7 +996,7 @@ public Builder setCompressionEnforced(boolean compressionEnforced) {
          * be done by calling code.
          */
         public Builder setEnableAutomaticDecompression(boolean enable) {
-            this.enableAutomaticDecompression = enable;
+            enableAutomaticDecompression = enable;
             return this;
         }
 

client/src/main/java/org/asynchttpclient/HttpResponseStatus.java

@@ -21,7 +21,7 @@
 import java.net.SocketAddress;
 
 /**
- * A class that represent the HTTP response' status line (code + text)
+ * A class that represent the HTTP response status line (code + text)
  */
 public abstract class HttpResponseStatus {
 

client/src/main/java/org/asynchttpclient/ListenableFuture.java

@@ -70,7 +70,7 @@ public interface ListenableFuture<V> extends Future<V> {
      * in the thread where completion happens.
      * <br>
      * There is no guaranteed ordering of execution of listeners, they may get
-     * called in the order they were added and they may get called out of order,
+     * called in the order they were added, and they may get called out of order,
      * but any listener added through this method is guaranteed to be called once
      * the computation is complete.
      *

client/src/main/java/org/asynchttpclient/Request.java

@@ -84,32 +84,32 @@ public interface Request {
     List<Cookie> getCookies();
 
     /**
-     * @return the request's body byte array (only non null if it was set this way)
+     * @return the request's body byte array (only non-null if it was set this way)
      */
     byte @Nullable [] getByteData();
 
     /**
-     * @return the request's body array of byte arrays (only non null if it was set this way)
+     * @return the request's body array of byte arrays (only non-null if it was set this way)
      */
     @Nullable List<byte[]> getCompositeByteData();
 
     /**
-     * @return the request's body string (only non null if it was set this way)
+     * @return the request's body string (only non-null if it was set this way)
      */
     @Nullable String getStringData();
 
     /**
-     * @return the request's body ByteBuffer (only non null if it was set this way)
+     * @return the request's body ByteBuffer (only non-null if it was set this way)
      */
     @Nullable ByteBuffer getByteBufferData();
 
     /**
-     * @return the request's body InputStream (only non null if it was set this way)
+     * @return the request's body InputStream (only non-null if it was set this way)
      */
     @Nullable InputStream getStreamData();
 
     /**
-     * @return the request's body BodyGenerator (only non null if it was set this way)
+     * @return the request's body BodyGenerator (only non-null if it was set this way)
      */
     @Nullable BodyGenerator getBodyGenerator();
 
@@ -159,7 +159,7 @@ public interface Request {
     Duration getRequestTimeout();
 
     /**
-     * @return the read timeout. Non zero values means "override config value".
+     * @return the read timeout. Non-zero values means "override config value".
      */
     Duration getReadTimeout();