com.stoyanr.evictor

Interface EvictionQueue<K,V>

Type Parameters:

K - the type of keys maintained by the map

V - the type of mapped values

All Known Implementing Classes:

NavigableMapEvictionQueue, PriorityEvictionQueue

public interface EvictionQueue<K,V>

A priority queue of evictible entries used by AbstractQueueEvictionScheduler to store entries that should be evicted automatically in the order in which they should be evicted. It provides methods for adding and removing entries, as well as evicting expired entries.

Author:

Stoyan Rachev

Method Summary

Methods

Modifier and Type	Method and Description
boolean	evictEntries() Evicts all entries that have expired from their maps and removes them from the queue.
long	getNextEvictionTime() Returns the next eviction time of all entries contained in the queue, or 0 if the queue is empty.
boolean	hasEntries() Returns true if this queue contains any entries.
void	putEntry(EvictibleEntry<K,V> e) Puts the specified evictible entry into the queue.
void	removeEntry(EvictibleEntry<K,V> e) Removes the specified evictible entry from the queue.

Method Detail

hasEntries

boolean hasEntries()

Returns true if this queue contains any entries.

Returns:

true if this queue contains any entries

getNextEvictionTime

long getNextEvictionTime()

Returns the next eviction time of all entries contained in the queue, or 0 if the queue is empty. Since the queue is sorted by the entries eviction time, this is the eviction time of the first entry (head).

Returns:

the next eviction time of all entries contained in the queue, or 0 if the queue is empty

putEntry

void putEntry(EvictibleEntry<K,V> e)

Puts the specified evictible entry into the queue.

Parameters:

e - the entry to be put into the queue.

Throws:

NullPointerException - if the entry is null

removeEntry

void removeEntry(EvictibleEntry<K,V> e)

Removes the specified evictible entry from the queue.

Parameters:

e - the entry to be removed from the queue.

Throws:

NullPointerException - if the entry is null

evictEntries

boolean evictEntries()

Evicts all entries that have expired from their maps and removes them from the queue.

Returns:

true if any entries have been evicted