com.stoyanr.evictor.scheduler

Class ExecutorServiceEvictionScheduler<K,V>

java.lang.Object

com.stoyanr.evictor.scheduler.ExecutorServiceEvictionScheduler<K,V>

Type Parameters:

K - the type of keys maintained by this map

V - the type of mapped values

All Implemented Interfaces:

EvictionScheduler<K,V>

public class ExecutorServiceEvictionScheduler<K,V>
extends Object
implements EvictionScheduler<K,V>

An EvictionScheduler which uses a ScheduledExecutorService to schedule multiple tasks for entries that should be evicted, one task per entry.

Author:

Stoyan Rachev

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_THREAD_POOL_SIZE

Constructor Summary

Constructors

Constructor and Description
ExecutorServiceEvictionScheduler() Creates an eviction scheduler with a ScheduledThreadPoolExecutor.
ExecutorServiceEvictionScheduler(ScheduledExecutorService executorService) Creates an eviction scheduler with the specified scheduled executor service.

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.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_THREAD_POOL_SIZE

public static final int DEFAULT_THREAD_POOL_SIZE

See Also:

Constant Field Values

Constructor Detail

ExecutorServiceEvictionScheduler

public ExecutorServiceEvictionScheduler()

Creates an eviction scheduler with a ScheduledThreadPoolExecutor.

ExecutorServiceEvictionScheduler

public ExecutorServiceEvictionScheduler(ScheduledExecutorService executorService)

Creates an eviction scheduler with the specified scheduled executor service.

Parameters:

executorService - the scheduled executor service to be used

Throws:

NullPointerException - if the scheduled executor service is null

Method Detail

scheduleEviction

public 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.

Specified by:

scheduleEviction in interface EvictionScheduler<K,V>

Parameters:

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

cancelEviction

public 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.

Specified by:

cancelEviction in interface EvictionScheduler<K,V>

Parameters:

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

shutdown

public 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.

This implementation simply invokes the shutdownNow method on the scheduled executor service.

Specified by:

shutdown in interface EvictionScheduler<K,V>