com.github.benmanes.caffeine.cache

Class RemovalNotification<K,V>

java.lang.Object

com.github.benmanes.caffeine.cache.RemovalNotification<K,V>

All Implemented Interfaces:

Map.Entry<K,V>

@Immutable
public final class RemovalNotification<K,V>
extends Object
implements Map.Entry<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. This class holds strong references to the key and value, regardless of the type of references the cache may be using.

Constructor Summary

Constructors

Constructor and Description
RemovalNotification(K key, V value, RemovalCause cause) Creates an entry representing a mapping from the specified key to the specified value.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
RemovalCause	getCause()
K	getKey() Returns the key of the removed entry or null if it was garbage collected due to Caffeine.weakKeys() eviction.
V	getValue() Returns the key of the removed entry or null if it was garbage collected due to Caffeine.weakValues() or Caffeine.softValues() eviction.
int	hashCode()
V	setValue(V value)
String	toString() Returns a string representation of the form {key}={value}.
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.lang.Object

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

Methods inherited from interface java.util.Map.Entry

comparingByKey, comparingByKey, comparingByValue, comparingByValue

Constructor Detail

RemovalNotification

public RemovalNotification(@Nullable
                           K key,
                           @Nullable
                           V value,
                           @Nonnull
                           RemovalCause cause)

Creates an entry representing a mapping from the specified key to the specified value.

Parameters:

key - the key represented by this entry

value - the value represented by this entry

cause - the reason for which the entry was removed

Method Detail

getCause

@Nonnull
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).

Returns:

if the entry was removed due to eviction

getKey

@Nullable
public K getKey()

Returns the key of the removed entry or null if it was garbage collected due to Caffeine.weakKeys() eviction.

Specified by:

getKey in interface Map.Entry<K,V>

getValue

@Nullable
public V getValue()

Returns the key of the removed entry or null if it was garbage collected due to Caffeine.weakValues() or Caffeine.softValues() eviction.

Specified by:

getValue in interface Map.Entry<K,V>

setValue

public final V setValue(V value)

Specified by:

setValue in interface Map.Entry<K,V>

equals

public boolean equals(Object o)

Specified by:

equals in interface Map.Entry<K,V>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Map.Entry<K,V>

Overrides:

hashCode in class Object

toString

public String toString()

Returns a string representation of the form {key}={value}.

Overrides:

toString in class Object