minor javadoc fixes

ben-manes · Apr 4, 2022 · d2644d8 · d2644d8
1 parent 2276462
commit d2644d8
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 11 deletions.
diff --git a/caffeine/src/main/java/com/github/benmanes/caffeine/cache/Caffeine.java b/caffeine/src/main/java/com/github/benmanes/caffeine/cache/Caffeine.java
@@ -697,8 +697,8 @@ boolean expiresAfterAccess() {
    * the future.
    *
    * @param expiry the expiry to use in calculating the expiration time of cache entries
-   * @param <K1> key type of the weigher
-   * @param <V1> value type of the weigher
+   * @param <K1> key type of the expiry
+   * @param <V1> value type of the expiry
    * @return this {@code Caffeine} instance (for chaining)
    * @throws IllegalStateException if expiration was already set
    */
@@ -731,12 +731,13 @@ boolean expiresVariable() {
   /**
    * Specifies that active entries are eligible for automatic refresh once a fixed duration has
    * elapsed after the entry's creation, or the most recent replacement of its value. The semantics
-   * of refreshes are specified in {@link LoadingCache#refresh}, and are performed by calling {@link
-   * CacheLoader#reload}.
+   * of refreshes are specified in {@link LoadingCache#refresh}, and are performed by calling
+   * {@link AsyncCacheLoader#asyncLoad}.
    * <p>
    * Automatic refreshes are performed when the first stale request for an entry occurs. The request
-   * triggering refresh will make an asynchronous call to {@link CacheLoader#reload} and immediately
-   * return the old value.
+   * triggering the refresh will make a synchronous call to {@link AsyncCacheLoader#asyncLoad} to
+   * obtain a future of the new value. If the returned future is already complete, it is returned
+   * immediately. Otherwise, the old value is returned.
    * <p>
    * <b>Note:</b> <i>all exceptions thrown during refresh will be logged and then swallowed</i>.
    *
@@ -755,11 +756,12 @@ public Caffeine<K, V> refreshAfterWrite(Duration duration) {
    * Specifies that active entries are eligible for automatic refresh once a fixed duration has
    * elapsed after the entry's creation, or the most recent replacement of its value. The semantics
    * of refreshes are specified in {@link LoadingCache#refresh}, and are performed by calling
-   * {@link CacheLoader#reload}.
+   * {@link AsyncCacheLoader#asyncLoad}.
    * <p>
    * Automatic refreshes are performed when the first stale request for an entry occurs. The request
-   * triggering refresh will make an asynchronous call to {@link CacheLoader#reload} and immediately
-   * return the old value.
+   * triggering the refresh will make a synchronous call to {@link AsyncCacheLoader#asyncLoad} to
+   * obtain a future of the new value. If the returned future is already complete, it is returned
+   * immediately. Otherwise, the old value is returned.
    * <p>
    * <b>Note:</b> <i>all exceptions thrown during refresh will be logged and then swallowed</i>.
    * <p>

diff --git a/gradle/dependencies.gradle b/gradle/dependencies.gradle
@@ -88,7 +88,7 @@ ext {
     bnd: '6.2.0',
     checkstyle: '10.1',
     coveralls: '2.12.0',
-    dependencyCheck: '7.0.3',
+    dependencyCheck: '7.0.4.1',
     errorprone: '2.0.2',
     findsecbugs: '1.11.0',
     jacoco: '0.8.7',

diff --git a/guava/src/main/java/com/github/benmanes/caffeine/guava/CaffeinatedGuavaCache.java b/guava/src/main/java/com/github/benmanes/caffeine/guava/CaffeinatedGuavaCache.java
@@ -239,7 +239,7 @@ static final class CacheLoaderException extends RuntimeException {
     CacheLoaderException(Exception e) {
       super(e);
     }
-    @SuppressWarnings("UnsynchronizedOverridesSynchronized")
+    @SuppressWarnings({"UnsynchronizedOverridesSynchronized", "lgtm [java/non-sync-override]"})
     @Override public Throwable fillInStackTrace() {
       return this;
     }