Caffeine cache 3.1.8 · com.github.benmanes.caffeine.cache.RemovalCause

public sealed Enum RemovalCause

Class Inheritance

java.lang.Object
java.lang.Enum
com.github.benmanes.caffeine.cache.RemovalCause

The reason why a cached entry was removed.

Field Summary

Modifier and Type	Field and Description
public static final RemovalCause	COLLECTED The entry was removed automatically because its key or value was garbage-collected.
public static final RemovalCause	EXPIRED The entry's expiration timestamp has passed.
public static final RemovalCause	EXPLICIT The entry was manually removed by the user.
public static final RemovalCause	REPLACED The entry itself was not actually removed, but its value was replaced by the user.
public static final RemovalCause	SIZE The entry was evicted due to size constraints.

Constructor Summary

Access	Constructor and Description
private	RemovalCause()

Method Summary

Modifier and Type	Method and Description
public static RemovalCause	valueOf(String name)
public static RemovalCause[]	values()
public abstract boolean	Returns: if the entry was automatically removed due to eviction wasEvicted() Returns `true` if there was an automatic removal due to eviction (the cause is neither `EXPLICIT` nor `REPLACED`).

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

COLLECTED	back to summary
public static final RemovalCause COLLECTED The entry was removed automatically because its key or value was garbage-collected. This can occur when using `Caffeine#weakKeys`, `Caffeine#weakValues`, or `Caffeine#softValues`.

EXPIRED	back to summary
public static final RemovalCause EXPIRED The entry's expiration timestamp has passed. This can occur when using `Caffeine#expireAfterWrite`, `Caffeine#expireAfterAccess`, or `Caffeine#expireAfter(Expiry)`.

EXPLICIT back to summary

EXPLICIT	back to summary
public static final RemovalCause 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` `Cache#invalidateAll(Iterable)` `Cache#invalidateAll()` `LoadingCache#refresh` `java.util.Map#remove` `java.util.Map#computeIfPresent` `java.util.Map#compute` `java.util.Map#merge` `java.util.concurrent.ConcurrentMap#remove` A manual removal may also be performed through the key, value, or entry collections views by the user invoking any of the following methods. `java.util.Collection#remove` `java.util.Collection#removeAll` `java.util.Collection#removeIf` `java.util.Collection#retainAll` `java.util.Iterator#remove`

public static final RemovalCause 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.

A manual removal may also be performed through the key, value, or entry collections views by the user invoking any of the following methods.

REPLACED back to summary

REPLACED	back to summary
public static final RemovalCause 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` `Cache#putAll` `LoadingCache#getAll` `LoadingCache#refresh` `java.util.Map#put` `java.util.Map#putAll` `java.util.Map#replace` `java.util.Map#computeIfPresent` `java.util.Map#compute` `java.util.Map#merge`

public static final RemovalCause 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.

SIZE	back to summary
public static final RemovalCause SIZE The entry was evicted due to size constraints. This can occur when using `Caffeine#maximumSize` or `Caffeine#maximumWeight`.

Constructor Detail

RemovalCause	back to summary
private RemovalCause()

Method Detail

valueOf	back to summary
public static RemovalCause valueOf(String name)

values	back to summary
public static RemovalCause[] values()

wasEvicted back to summary

wasEvicted	back to summary
public abstract boolean wasEvicted() Returns `true` if there was an automatic removal due to eviction (the cause is neither `EXPLICIT` nor `REPLACED`). Returns:boolean if the entry was automatically removed due to eviction

public abstract boolean wasEvicted()

Returns true if there was an automatic removal due to eviction (the cause is neither EXPLICIT nor REPLACED).

Returns:boolean: if the entry was automatically removed due to eviction