Enum Class RemovalCause
- All Implemented Interfaces:
Serializable
,Comparable<RemovalCause>
,Constable
The reason why a cached entry was removed.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionThe entry was removed automatically because its key or value was garbage-collected.The entry's expiration timestamp has passed.The entry was manually removed by the user.The entry itself was not actually removed, but its value was replaced by the user.The entry was evicted due to size constraints. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic RemovalCause
Returns the enum constant of this class with the specified name.static RemovalCause[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.abstract boolean
-
Enum Constant Details
-
EXPLICIT
The entry was manually removed by the user. This can result from the user invoking any of the following methods on the cache or map view.Cache.invalidate(java.lang.Object)
Cache.invalidateAll(Iterable)
Cache.invalidateAll()
Map.remove(java.lang.Object)
Map.computeIfPresent(K, java.util.function.BiFunction<? super K, ? super V, ? extends V>)
Map.compute(K, java.util.function.BiFunction<? super K, ? super V, ? extends V>)
Map.merge(K, V, java.util.function.BiFunction<? super V, ? super V, ? extends V>)
ConcurrentMap.remove(java.lang.Object, java.lang.Object)
-
REPLACED
The entry itself was not actually removed, but its value was replaced by the user. This can result from the user invoking any of the following methods on the cache or map view.Cache.put(K, V)
Cache.putAll(java.util.Map<? extends K, ? extends V>)
LoadingCache.getAll(java.lang.Iterable<? extends K>)
LoadingCache.refresh(K)
Map.put(K, V)
Map.putAll(java.util.Map<? extends K, ? extends V>)
Map.replace(K, V, V)
Map.computeIfPresent(K, java.util.function.BiFunction<? super K, ? super V, ? extends V>)
Map.compute(K, java.util.function.BiFunction<? super K, ? super V, ? extends V>)
Map.merge(K, V, java.util.function.BiFunction<? super V, ? super V, ? extends V>)
-
COLLECTED
The entry was removed automatically because its key or value was garbage-collected. This can occur when usingCaffeine.weakKeys()
,Caffeine.weakValues()
, orCaffeine.softValues()
. -
EXPIRED
The entry's expiration timestamp has passed. This can occur when usingCaffeine.expireAfterWrite(long, java.util.concurrent.TimeUnit)
orCaffeine.expireAfterAccess(long, java.util.concurrent.TimeUnit)
. -
SIZE
The entry was evicted due to size constraints. This can occur when usingCaffeine.maximumSize
orCaffeine.maximumWeight
.
-
-
Constructor Details
-
RemovalCause
private RemovalCause()
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
-
wasEvicted
public abstract boolean wasEvicted()Returnstrue
if there was an automatic removal due to eviction (the cause is neitherEXPLICIT
norREPLACED
).- Returns:
- if the entry was automatically removed due to eviction
-