com.diffplug.common.cache

Class RemovalNotification<K,V>

java.lang.Object

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

All Implemented Interfaces:

Map.Entry<K,V>

@GwtCompatible
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.

Like other Map.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

Method Summary

Modifier and Type	Method and 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.
boolean	equals(Object object)
RemovalCause	getCause() Returns the cause for which the entry was removed.
K	getKey()
V	getValue()
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

Method Detail

create

public static <K,V> RemovalNotification<K,V> create(@Nullable
                                                    K key,
                                                    @Nullable
                                                    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).

getKey

@Nullable
public K getKey()

Specified by:

getKey in interface Map.Entry<K,V>

getValue

@Nullable
public V getValue()

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(@Nullable
                      Object object)

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