Top Description Fields Constructors Methods

com.google.common.cache

public sealed Enum RemovalCause

Class Inheritance

extends Enum<RemovalCause>

java.lang.Object
java.lang.Enum
com.google.common.cache.RemovalCause

Annotations

@GwtCompatible
@ElementTypesAreNonnullByDefault

Imports

com.google.common.annotations.GwtCompatible, java.util.Iterator, .Map, java.util.concurrent.ConcurrentMap

The reason why a cached entry was removed.

Author: Charles Fry
Since: 10.0

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()
pack-priv abstract boolean	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 `CacheBuilder#weakKeys`, `CacheBuilder#weakValues`, or `CacheBuilder#softValues`.

EXPIRED	back to summary
public static final RemovalCause EXPIRED The entry's expiration timestamp has passed. This can occur when using `CacheBuilder#expireAfterWrite` or `CacheBuilder#expireAfterAccess`.

EXPLICIT	back to summary
public static final RemovalCause EXPLICIT The entry was manually removed by the user. This can result from the user invoking `Cache#invalidate`, `Cache#invalidateAll(Iterable)`, `Cache#invalidateAll()`, `Map#remove`, `ConcurrentMap#remove`, or `Iterator#remove`.

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 `Cache#put`, `LoadingCache#refresh`, `Map#put`, `Map#putAll`, `ConcurrentMap#replace(Object, Object)`, or `ConcurrentMap#replace(Object, Object, Object)`.

SIZE	back to summary
public static final RemovalCause SIZE The entry was evicted due to size constraints. This can occur when using `CacheBuilder#maximumSize` or `CacheBuilder#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
pack-priv abstract boolean wasEvicted() Returns `true` if there was an automatic removal due to eviction (the cause is neither `EXPLICIT` nor `REPLACED`).