Update version to 3.0.0

ben-manes · ben-manes · commit 16ddc49000a5 · 2021-02-15T23:45:24.000-08:00
diff --git a/README.md b/README.md
@@ -35,7 +35,7 @@ Caffeine provides flexible construction to create a cache with a combination of
  * keys automatically wrapped in [weak references][reference]
  * values automatically wrapped in [weak or soft references][reference]
  * [notification][listener] of evicted (or otherwise removed) entries
- * [writes propagated][writer] to an external resource
+ * [writes propagated][compute] to an external resource
  * accumulation of cache access [statistics][statistics]
 
 In addition, Caffeine offers the following extensions:
@@ -82,11 +82,11 @@ Powering infrastructure near you:
 Download from [Maven Central][maven] or depend via Gradle:
 
 ```gradle
-implementation 'com.github.ben-manes.caffeine:caffeine:2.9.0'
+implementation 'com.github.ben-manes.caffeine:caffeine:3.0.0'
 
 // Optional extensions
-implementation 'com.github.ben-manes.caffeine:guava:2.9.0'
-implementation 'com.github.ben-manes.caffeine:jcache:2.9.0'
+implementation 'com.github.ben-manes.caffeine:guava:3.0.0'
+implementation 'com.github.ben-manes.caffeine:jcache:3.0.0'
 ```
 
 See the [release notes][releases] for details of the changes.
@@ -105,7 +105,7 @@ Snapshots of the development version are available in
 [refresh]: https://github.com/ben-manes/caffeine/wiki/Refresh
 [reference]: https://github.com/ben-manes/caffeine/wiki/Eviction#reference-based
 [listener]: https://github.com/ben-manes/caffeine/wiki/Removal
-[writer]: https://github.com/ben-manes/caffeine/wiki/Writer
+[compute]: https://github.com/ben-manes/caffeine/wiki/Compute
 [statistics]: https://github.com/ben-manes/caffeine/wiki/Statistics
 [simulator]: https://github.com/ben-manes/caffeine/wiki/Simulator
 [guava-adapter]: https://github.com/ben-manes/caffeine/wiki/Guava
diff --git a/build.gradle b/build.gradle
@@ -39,8 +39,8 @@ allprojects {
 
   group = 'com.github.ben-manes.caffeine'
   version.with {
-    major = 2 // incompatible API changes
-    minor = 9 // backwards-compatible additions
+    major = 3 // incompatible API changes
+    minor = 0 // backwards-compatible additions
     patch = 0 // backwards-compatible bug fixes
     releaseBuild = rootProject.hasProperty('release')
   }
diff --git a/caffeine/src/main/java/com/github/benmanes/caffeine/cache/AsyncCacheLoader.java b/caffeine/src/main/java/com/github/benmanes/caffeine/cache/AsyncCacheLoader.java
@@ -123,6 +123,8 @@ default CompletableFuture<? extends V> asyncReload(
    *   AsyncLoadingCache<Key, Graph> cache = Caffeine.newBuilder().buildAsync(loader);
    * }</pre>
    *
+   * @param <K> the key type
+   * @param <V> the value type
    * @param mappingFunction the function to asynchronously compute the values
    * @return an asynchronous cache loader that delegates to the supplied {@code mappingFunction}
    * @throws NullPointerException if the mappingFunction is null
@@ -145,6 +147,8 @@ static <K extends Object, V extends Object> AsyncCacheLoader<K, V> bulk(
    *   AsyncLoadingCache<Key, Graph> cache = Caffeine.newBuilder().buildAsync(loader);
    * }</pre>
    *
+   * @param <K> the key type
+   * @param <V> the value type
    * @param mappingFunction the function to asynchronously compute the values
    * @return an asynchronous cache loader that delegates to the supplied {@code mappingFunction}
    * @throws NullPointerException if the mappingFunction is null
diff --git a/caffeine/src/main/java/com/github/benmanes/caffeine/cache/CacheLoader.java b/caffeine/src/main/java/com/github/benmanes/caffeine/cache/CacheLoader.java
@@ -209,6 +209,8 @@ default CompletableFuture<? extends V> asyncReload(
    *   LoadingCache<Key, Graph> cache = Caffeine.newBuilder().build(loader);
    * }</pre>
    *
+   * @param <K> the key type
+   * @param <V> the value type
    * @param mappingFunction the function to compute the values
    * @return a cache loader that delegates to the supplied {@code mappingFunction}
    * @throws NullPointerException if the mappingFunction is null
diff --git a/caffeine/src/main/java/com/github/benmanes/caffeine/cache/stats/CacheStats.java b/caffeine/src/main/java/com/github/benmanes/caffeine/cache/stats/CacheStats.java
@@ -99,6 +99,7 @@ private CacheStats(@NonNegative long hitCount, @NonNegative long missCount,
    * @param totalLoadTime the total load time (success and failure)
    * @param evictionCount the number of entries evicted from the cache
    * @param evictionWeight the sum of weights of entries evicted from the cache
+   * @return a {@code CacheStats} representing the specified statistics
    */
   public static CacheStats of(@NonNegative long hitCount, @NonNegative long missCount,
       @NonNegative long loadSuccessCount, @NonNegative long loadFailureCount,

Original file line number	Diff line number	Diff line change
`@@ -209,6 +209,8 @@ default CompletableFuture<? extends V> asyncReload(`
`209`	`209`	`* LoadingCache<Key, Graph> cache = Caffeine.newBuilder().build(loader);`
`210`	`210`	`* }</pre>`
`211`	`211`	`*`
	`212`	`+ * @param <K> the key type`
	`213`	`+ * @param <V> the value type`
`212`	`214`	`* @param mappingFunction the function to compute the values`
`213`	`215`	`* @return a cache loader that delegates to the supplied {@code mappingFunction}`
`214`	`216`	`* @throws NullPointerException if the mappingFunction is null`