From 3d502c9ac4b6ac2d24ed0b779e6291d75ef0dd9d Mon Sep 17 00:00:00 2001 From: Michael Osipov Date: Sun, 15 Dec 2019 10:55:55 +0100 Subject: [PATCH] Correct Javadoc --- .../ExponentialBackOffSchedulingStrategy.java | 14 +++++++------- .../http/impl/async/HttpAsyncMainClientExec.java | 2 +- .../io/PoolingHttpClientConnectionManager.java | 2 +- .../PoolingHttpClientConnectionManagerBuilder.java | 2 +- .../nio/PoolingAsyncClientConnectionManager.java | 2 +- ...PoolingAsyncClientConnectionManagerBuilder.java | 2 +- .../apache/hc/client5/http/utils/DateUtils.java | 4 ++-- 7 files changed, 14 insertions(+), 14 deletions(-) diff --git a/httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/schedule/ExponentialBackOffSchedulingStrategy.java b/httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/schedule/ExponentialBackOffSchedulingStrategy.java index b00b188bd..a9a808c1d 100644 --- a/httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/schedule/ExponentialBackOffSchedulingStrategy.java +++ b/httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/schedule/ExponentialBackOffSchedulingStrategy.java @@ -36,13 +36,13 @@ import org.apache.hc.core5.util.TimeValue; * An implementation that backs off exponentially based on the number of * consecutive failed attempts. It uses the following defaults: * 
- *         no delay in case it was never tried or didn't fail so far
- *     6 secs delay for one failed attempt (= {@link #getInitialExpiry()})
- *    60 secs delay for two failed attempts
- *    10 mins delay for three failed attempts
- *   100 mins delay for four failed attempts
- *  ~16 hours delay for five failed attempts
- *   24 hours delay for six or more failed attempts (= {@link #getMaxExpiry()})
+ *      no delay in case it was never tried or didn't fail so far
+ *     6 s delay for one failed attempt (= {@link #getInitialExpiry()})
+ *    60 s delay for two failed attempts
+ *  10 min delay for three failed attempts
+ * 100 min delay for four failed attempts
+ *   ~16 h delay for five failed attempts
+ *    24 h delay for six or more failed attempts (= {@link #getMaxExpiry()})
  *
* * The following equation is used to calculate the delay for a specific pending operation: diff --git a/httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/HttpAsyncMainClientExec.java b/httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/HttpAsyncMainClientExec.java index f09b51f8e..9299a8a38 100644 --- a/httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/HttpAsyncMainClientExec.java +++ b/httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/HttpAsyncMainClientExec.java @@ -66,7 +66,7 @@ import org.slf4j.LoggerFactory; /** * Usually the last HTTP/1.1 request execution handler in the asynchronous * request execution chain that is responsible for execution of - * request / response exchanges with the opposite endpoint. + * request/response exchanges with the opposite endpoint. * * @since 5.0 */ diff --git a/httpclient5/src/main/java/org/apache/hc/client5/http/impl/io/PoolingHttpClientConnectionManager.java b/httpclient5/src/main/java/org/apache/hc/client5/http/impl/io/PoolingHttpClientConnectionManager.java index 52e7719cb..1798dba86 100644 --- a/httpclient5/src/main/java/org/apache/hc/client5/http/impl/io/PoolingHttpClientConnectionManager.java +++ b/httpclient5/src/main/java/org/apache/hc/client5/http/impl/io/PoolingHttpClientConnectionManager.java @@ -505,7 +505,7 @@ public class PoolingHttpClientConnectionManager } /** - * Defines period of inactivity in milliseconds after which persistent connections must + * Defines period of inactivity after which persistent connections must * be re-validated prior to being {@link #lease(String, HttpRoute, Object)} leased} to the consumer. * Non-positive value passed to this method disables connection validation. This check helps * detect connections that have become stale (half-closed) while kept inactive in the pool. diff --git a/httpclient5/src/main/java/org/apache/hc/client5/http/impl/io/PoolingHttpClientConnectionManagerBuilder.java b/httpclient5/src/main/java/org/apache/hc/client5/http/impl/io/PoolingHttpClientConnectionManagerBuilder.java index 994232d32..98ea2eb13 100644 --- a/httpclient5/src/main/java/org/apache/hc/client5/http/impl/io/PoolingHttpClientConnectionManagerBuilder.java +++ b/httpclient5/src/main/java/org/apache/hc/client5/http/impl/io/PoolingHttpClientConnectionManagerBuilder.java @@ -177,7 +177,7 @@ public class PoolingHttpClientConnectionManagerBuilder { } /** - * Sets period after inactivity in milliseconds after which persistent + * Sets period after inactivity after which persistent * connections must be checked to ensure they are still valid. * * @see org.apache.hc.core5.http.io.HttpClientConnection#isStale() diff --git a/httpclient5/src/main/java/org/apache/hc/client5/http/impl/nio/PoolingAsyncClientConnectionManager.java b/httpclient5/src/main/java/org/apache/hc/client5/http/impl/nio/PoolingAsyncClientConnectionManager.java index f7934dd98..81fcfa9c1 100644 --- a/httpclient5/src/main/java/org/apache/hc/client5/http/impl/nio/PoolingAsyncClientConnectionManager.java +++ b/httpclient5/src/main/java/org/apache/hc/client5/http/impl/nio/PoolingAsyncClientConnectionManager.java @@ -476,7 +476,7 @@ public class PoolingAsyncClientConnectionManager implements AsyncClientConnectio } /** - * Defines period of inactivity in milliseconds after which persistent connections must + * Defines period of inactivity after which persistent connections must * be re-validated prior to being {@link #lease(String, HttpRoute, Object, Timeout, * FutureCallback)} leased} to the consumer. Non-positive value passed * to this method disables connection validation. This check helps detect connections diff --git a/httpclient5/src/main/java/org/apache/hc/client5/http/impl/nio/PoolingAsyncClientConnectionManagerBuilder.java b/httpclient5/src/main/java/org/apache/hc/client5/http/impl/nio/PoolingAsyncClientConnectionManagerBuilder.java index 71af69a75..ad390b65c 100644 --- a/httpclient5/src/main/java/org/apache/hc/client5/http/impl/nio/PoolingAsyncClientConnectionManagerBuilder.java +++ b/httpclient5/src/main/java/org/apache/hc/client5/http/impl/nio/PoolingAsyncClientConnectionManagerBuilder.java @@ -154,7 +154,7 @@ public class PoolingAsyncClientConnectionManagerBuilder { } /** - * Sets period after inactivity in milliseconds after which persistent + * Sets period after inactivity after which persistent * connections must be checked to ensure they are still valid. * * @see org.apache.hc.core5.http.io.HttpClientConnection#isStale() diff --git a/httpclient5/src/main/java/org/apache/hc/client5/http/utils/DateUtils.java b/httpclient5/src/main/java/org/apache/hc/client5/http/utils/DateUtils.java index 04167c2d7..d59c6d3c1 100644 --- a/httpclient5/src/main/java/org/apache/hc/client5/http/utils/DateUtils.java +++ b/httpclient5/src/main/java/org/apache/hc/client5/http/utils/DateUtils.java @@ -118,7 +118,7 @@ public final class DateUtils { } /** - * Tests if the first message is after (newer) than seconds message + * Tests if the first message is after (newer) than second one * using the given message header for comparison. * * @param message1 the first message @@ -154,7 +154,7 @@ public final class DateUtils { } /** - * Tests if the first message is before (older) than seconds message + * Tests if the first message is before (older) than the second one * using the given message header for comparison. * * @param message1 the first message