Package com.google.common.cache

Class RemovalNotification<K,V>

java.lang.Object

java.util.AbstractMap.SimpleImmutableEntry<K,V>

com.google.common.cache.RemovalNotification<K,V>

All Implemented Interfaces:

java.io.Serializable, java.util.Map.Entry<K,V>

public final class RemovalNotification<K,V>
extends java.util.AbstractMap.SimpleImmutableEntry<K,V>

A notification of the removal of a single entry. The key and/or value may be null if they were already garbage collected.

Like other Entry instances associated with CacheBuilder, this class holds strong references to the key and value, regardless of the type of references the cache may be using.

Since:

10.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private RemovalCause	cause
private static long	serialVersionUID

Constructor Summary

Constructors

Modifier	Constructor	Description
private	RemovalNotification(K key, V value, RemovalCause cause)

Method Summary

Modifier and Type	Method	Description
static <K,V> RemovalNotification<K,V>	create(K key, V value, RemovalCause cause)	Creates a new RemovalNotification for the given key/value pair, with the given cause for the removal.
RemovalCause	getCause()	Returns the cause for which the entry was removed.
boolean	wasEvicted()	Returns true if there was an automatic removal due to eviction (the cause is neither RemovalCause.EXPLICIT nor RemovalCause.REPLACED).

Methods inherited from class java.util.AbstractMap.SimpleImmutableEntry

equals, getKey, getValue, hashCode, setValue, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

cause

private final RemovalCause cause

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

RemovalNotification

private RemovalNotification(K key,
                            V value,
                            RemovalCause cause)

Method Detail

create

public static <K,V> RemovalNotification<K,V> create(K key,
                                                                V value,
                                                                RemovalCause cause)

Creates a new RemovalNotification for the given key/value pair, with the given cause for the removal. The key and/or value may be null if they were already garbage collected.

Since:

19.0

getCause

public RemovalCause getCause()

Returns the cause for which the entry was removed.

wasEvicted

public boolean wasEvicted()

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