com.stoyanr.evictor.map

Class EvictibleEntry<K,V>

java.lang.Object

com.stoyanr.evictor.map.EvictibleEntry<K,V>

Type Parameters:

K - the type of keys maintained by the map

V - the type of mapped values

All Implemented Interfaces:

Map.Entry<K,V>

public class EvictibleEntry<K,V>
extends Object
implements Map.Entry<K,V>

An evictible map Map.Entry used by ConcurrentMapWithTimedEvictionDecorator and other interfaces and classes in this package. Besides the key and the value, the entry has additional properties such as its map, eviction time, and custom data, as well as additional helper methods.

Author:

Stoyan Rachev

Method Summary

Methods

Modifier and Type	Method and Description
void	evict(boolean cancelPendingEviction) Actually evicts the entry from its map by calling the evict method on the map, passing the specified flag.
Object	getData() Returns the additional data associated with this entry.
long	getEvictionTime() Returns the eviction time of this entry, in nanoseconds.
K	getKey() Returns the key corresponding to this entry.
V	getValue() Returns the value corresponding to this entry.
boolean	isEvictible() Returns true if the entry is evictible.
void	setData(Object data) Sets the additional data associated with this entry.
V	setValue(V value) Replaces the value corresponding to this entry with the specified value.
boolean	shouldEvict() Returns true if the entry should be evicted.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map.Entry

equals, hashCode

Method Detail

getKey

public K getKey()

Returns the key corresponding to this entry.

Specified by:

getKey in interface Map.Entry<K,V>

Returns:

the key corresponding to this entry

getValue

public V getValue()

Returns the value corresponding to this entry.

Specified by:

getValue in interface Map.Entry<K,V>

Returns:

the value corresponding to this entry

setValue

public V setValue(V value)

Replaces the value corresponding to this entry with the specified value. (Writes through to the map.)

Specified by:

setValue in interface Map.Entry<K,V>

Parameters:

value - new value to be stored in this entry

Returns:

old value corresponding to the entry

Throws:

ClassCastException - if the class of the specified value prevents it from being stored in the backing map

NullPointerException - if the specified value is null

isEvictible

public boolean isEvictible()

Returns true if the entry is evictible. An entry is evictible if the value of evictMs specified upon its construction was positive.

Returns:

true if the entry is evictible

getEvictionTime

public long getEvictionTime()

Returns the eviction time of this entry, in nanoseconds. This time is calculated upon creation by adding the specified evictMs to the current time returned by System.nanoTime().

Returns:

the eviction time of this entry in nanoseconds.

getData

public Object getData()

Returns the additional data associated with this entry.

Returns:

the additional data associated with this entry

setData

public void setData(Object data)

Sets the additional data associated with this entry.

Parameters:

data - additional data associated with this entry

shouldEvict

public boolean shouldEvict()

Returns true if the entry should be evicted. An entry should be evicted if it is evictible and its eviction time is less than System.nanoTime().

Returns:

true if the entry should be evicted

evict

public void evict(boolean cancelPendingEviction)

Actually evicts the entry from its map by calling the evict method on the map, passing the specified flag.

Parameters:

cancelPendingEviction - true if any pending evictions of the entry should be cancelled

toString

public String toString()

Overrides:

toString in class Object