com.google.common.collect

Enum MapMaker.RemovalCause

java.lang.Object

java.lang.Enum<MapMaker.RemovalCause>

com.google.common.collect.MapMaker.RemovalCause

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MapMaker.RemovalCause>

Enclosing class:

MapMaker

static enum MapMaker.RemovalCause
extends java.lang.Enum<MapMaker.RemovalCause>

The reason why an 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 MapMaker.RemovalCause	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static MapMaker.RemovalCause[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
(package private) 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 MapMaker.RemovalCause EXPLICIT

The entry was manually removed by the user. This can result from the user invoking Map.remove(java.lang.Object), ConcurrentMap.remove(java.lang.Object, java.lang.Object), or Iterator.remove().

REPLACED

public static final MapMaker.RemovalCause REPLACED

The entry itself was not actually removed, but its value was replaced by the user. This can result from the user invoking Map.put(K, V), Map.putAll(java.util.Map<? extends K, ? extends V>), ConcurrentMap.replace(Object, Object), or ConcurrentMap.replace(Object, Object, Object).

COLLECTED

public static final MapMaker.RemovalCause COLLECTED

The entry was removed automatically because its key or value was garbage-collected. This can occur when using MapMaker.softValues(), MapMaker.weakKeys(), or MapMaker.weakValues().

EXPIRED

public static final MapMaker.RemovalCause EXPIRED

The entry's expiration timestamp has passed. This can occur when using MapMaker.expireAfterWrite(long, java.util.concurrent.TimeUnit) or MapMaker.expireAfterAccess(long, java.util.concurrent.TimeUnit).

SIZE

public static final MapMaker.RemovalCause SIZE

The entry was evicted due to size constraints. This can occur when using MapMaker.maximumSize.

Method Detail

values

public static MapMaker.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 (MapMaker.RemovalCause c : MapMaker.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 MapMaker.RemovalCause valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

wasEvicted

abstract boolean wasEvicted()

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