com.stoyanr.evictor

Interface EvictionScheduler<K,V>

Type Parameters:

K - the type of keys maintained by the map

V - the type of mapped values

All Known Implementing Classes:

AbstractQueueEvictionScheduler, DelayedTaskEvictionScheduler, ExecutorServiceEvictionScheduler, RegularTaskEvictionScheduler, SingleThreadEvictionScheduler

public interface EvictionScheduler<K,V>

An eviction scheduler used by ConcurrentMapWithTimedEvictionDecorator to automatically evict entries upon expiration. It provides methods for scheduling the eviction of newly added entries as well as canceling the eviction of entries that have been removed form the map.

Note that one eviction scheduler instance can be reused by more than one map.

Author:

Stoyan Rachev

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelEviction(EvictibleEntry<K,V> e) Cancels the eviction of the specified entry from its map.
void	scheduleEviction(EvictibleEntry<K,V> e) Schedules the eviction of the specified entry from its map.
void	shutdown() Immediately shuts down the scheduler and cancels all pending evictions.

Method Detail

scheduleEviction

void scheduleEviction(EvictibleEntry<K,V> e)

Schedules the eviction of the specified entry from its map. This method is called by the associated instances of ConcurrentMapWithTimedEvictionDecorator just after a new entry has been added. The entry is not guaranteed to be evictible, it may also be a permanent entry. Therefore, the implementation should check if this entry is evictible before doing any scheduling.

Parameters:

e - the entry for which the eviction should be scheduled, if evictible; it must have been already added to its map

Throws:

NullPointerException - if the entry is null

cancelEviction

void cancelEviction(EvictibleEntry<K,V> e)

Cancels the eviction of the specified entry from its map. This method is called by the associated instances of ConcurrentMapWithTimedEvictionDecorator just after an entry has been removed. The entry is not guaranteed to be evictible, it may also be a permanent entry. Therefore, the implementation should check if this entry is evictible before doing any cancellation.

Parameters:

e - the entry for which the eviction should be cancelled, if evictible; it must have been already removed from its map

Throws:

NullPointerException - if the entry is null

shutdown

void shutdown()

Immediately shuts down the scheduler and cancels all pending evictions. After it has been shut down, the scheduler cannot be used any more. This method is never called by the associated instances of ConcurrentMapWithTimedEvictionDecorator. Instead, it is intended to be called by the client that has created the scheduler to properly shut it down when it's not needed any more.