Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix some mistakes in the documentation. #1697

Merged
merged 1 commit into from
May 30, 2024
Merged

Fix some mistakes in the documentation. #1697

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions caffeine/src/main/java/com/github/benmanes/caffeine/cache/Caffeine.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -380,16 +380,16 @@ Scheduler getScheduler() {
* be used again. For example, the cache may evict an entry because it hasn't been used recently
* or very often.
* <p>
* When {@code size} is zero, elements will be evicted immediately after being loaded into the
* cache. This can be useful in testing, or to disable caching temporarily without a code change.
* As eviction is scheduled on the configured {@link #executor}, tests may instead prefer
* When {@code maximumSize} is zero, elements will be evicted immediately after being loaded into
* the cache. This can be useful in testing, or to disable caching temporarily without a code
* change. As eviction is scheduled on the configured {@link #executor}, tests may instead prefer
* to configure the cache to execute tasks directly on the same thread.
* <p>
* This feature cannot be used in conjunction with {@link #maximumWeight}.
*
* @param maximumSize the maximum size of the cache
* @return this {@code Caffeine} instance (for chaining)
* @throws IllegalArgumentException if {@code size} is negative
* @throws IllegalArgumentException if {@code maximumSize} is negative
* @throws IllegalStateException if a maximum size or weight was already set
*/
@CanIgnoreReturnValue
Expand Down Expand Up @@ -886,8 +886,8 @@ Ticker getTicker() {
* {@link ClassCastException} being thrown by a cache operation at some <i>undefined</i> point in
* the future.
* <p>
* <b>Warning:</b> any exception thrown by {@code listener} will <i>not</i> be propagated to the
* {@code Cache} user, only logged via a {@link Logger}.
* <b>Warning:</b> any exception thrown by {@code evictionListener} will <i>not</i> be propagated
* to the {@code Cache} user, only logged via a {@link Logger}.
* <p>
* This feature cannot be used in conjunction when {@link #weakKeys()} is combined with
* {@link #buildAsync}.
Expand Down Expand Up @@ -941,8 +941,8 @@ public <K1 extends K, V1 extends V> Caffeine<K1, V1> evictionListener(
* {@link ClassCastException} being thrown by a cache operation at some <i>undefined</i> point in
* the future.
* <p>
* <b>Warning:</b> any exception thrown by {@code listener} will <i>not</i> be propagated to the
* {@code Cache} user, only logged via a {@link Logger}.
* <b>Warning:</b> any exception thrown by {@code removalListener} will <i>not</i> be propagated
* to the {@code Cache} user, only logged via a {@link Logger}.
*
* @param removalListener a listener instance that caches should notify each time an entry is
* removed
Expand Down Expand Up @@ -977,7 +977,7 @@ public <K1 extends K, V1 extends V> Caffeine<K1, V1> removalListener(
* Enables the accumulation of {@link CacheStats} during the operation of the cache. Without this
* {@link Cache#stats} will return zero for all statistics. Note that recording statistics
* requires bookkeeping to be performed with each operation, and thus imposes a performance
* penalty on cache operation.
* penalty on cache operations.
*
* @return this {@code Caffeine} instance (for chaining)
*/
Expand All @@ -992,7 +992,7 @@ public Caffeine<K, V> recordStats() {
* Enables the accumulation of {@link CacheStats} during the operation of the cache. Without this
* {@link Cache#stats} will return zero for all statistics. Note that recording statistics
* requires bookkeeping to be performed with each operation, and thus imposes a performance
* penalty on cache operation. Any exception thrown by the supplied {@link StatsCounter} will be
* penalty on cache operations. Any exception thrown by the supplied {@link StatsCounter} will be
* suppressed and logged.
*
* @param statsCounterSupplier a supplier instance that returns a new {@link StatsCounter}
Expand Down Expand Up @@ -1100,7 +1100,7 @@ public <K1 extends K, V1 extends V> LoadingCache<K1, V1> build(
public <K1 extends K, V1 extends V> AsyncCache<K1, V1> buildAsync() {
requireState(valueStrength == null, "Weak or soft values can not be combined with AsyncCache");
requireState(isStrongKeys() || (evictionListener == null),
"Weak keys cannot be combined eviction listener and with AsyncLoadingCache");
"Weak keys cannot be combined with eviction listener and AsyncLoadingCache");
requireWeightWithWeigher();
requireNonLoadingCache();

Expand Down
Loading