com.github.benmanes.caffeine.cache

Enum RemovalCause

java.lang.Object

java.lang.Enum<RemovalCause>

com.github.benmanes.caffeine.cache.RemovalCause

All Implemented Interfaces:

Serializable, Comparable<RemovalCause>

public enum RemovalCause
extends Enum<RemovalCause>

The reason why a cached entry was removed.

Enum Constant Summary

Enum Constants

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

Method Summary

Modifier and Type	Method and Description
static RemovalCause	valueOf(String name) Returns the enum constant of this type with the specified name.
static RemovalCause[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
abstract boolean	wasEvicted() Returns true if there was an automatic removal due to eviction (the cause is neither EXPLICIT nor REPLACED).

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EXPLICIT

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(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)

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

• Collection.remove(java.lang.Object)
• Collection.removeAll(java.util.Collection<?>)
• Collection.removeIf(java.util.function.Predicate<? super E>)
• Collection.retainAll(java.util.Collection<?>)
• Iterator.remove()

REPLACED

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(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

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

public static final RemovalCause EXPIRED

The entry's expiration timestamp has passed. This can occur when using Caffeine.expireAfterWrite(java.time.Duration), Caffeine.expireAfterAccess(java.time.Duration), or Caffeine.expireAfter(Expiry).

SIZE

public static final RemovalCause SIZE

The entry was evicted due to size constraints. This can occur when using Caffeine.maximumSize or Caffeine.maximumWeight.

Method Detail

values

public static RemovalCause[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RemovalCause c : RemovalCause.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RemovalCause valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

wasEvicted

public abstract boolean wasEvicted()

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

Returns:

if the entry was automatically removed due to eviction