public final Class RemovalNotification<K, V>

Class Inheritance

extends AbstractMap.SimpleImmutableEntry<@Nullable K, @Nullable V>

java.lang.Object
java.util.AbstractMap.SimpleImmutableEntry
com.google.common.cache.RemovalNotification

Annotations

@GwtCompatible
@ElementTypesAreNonnullByDefault

Static Imports

com.google.common.base.Preconditions.checkNotNull

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.

Author: Charles Fry
Since: 10.0

Field Summary

Modifier and Type	Field and Description
private final RemovalCause	cause
private static final long	serialVersionUID Hides java.util.AbstractMap.SimpleImmutableEntry.serialVersionUID.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
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.
public RemovalCause	getCause() Returns the cause for which the entry was removed.
public boolean	wasEvicted() Returns `true` if there was an automatic removal due to eviction (the cause is neither `RemovalCause#EXPLICIT` nor `RemovalCause#REPLACED`).

Inherited from java.util.AbstractMap.SimpleImmutableEntry:: equals getKey getValue hashCode setValue toString

Field Detail

cause	back to summary
private final RemovalCause cause

serialVersionUID	back to summary
private static final long serialVersionUID Hides java.util.AbstractMap.SimpleImmutableEntry.serialVersionUID.

Constructor Detail

RemovalNotification	back to summary
private RemovalNotification(K key, V value, RemovalCause cause)

Method Detail

create back to summary

create	back to summary
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

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	back to summary
public RemovalCause getCause() Returns the cause for which the entry was removed.

wasEvicted	back to summary
public boolean wasEvicted() Returns `true` if there was an automatic removal due to eviction (the cause is neither `RemovalCause#EXPLICIT` nor `RemovalCause#REPLACED`).