com.github.wuic.engine.core

Class ScheduledCacheEngine

java.lang.Object

com.github.wuic.engine.Engine

com.github.wuic.engine.HeadEngine

com.github.wuic.engine.core.AbstractCacheEngine

com.github.wuic.engine.core.ScheduledCacheEngine

All Implemented Interfaces:

Comparable<Engine>, Runnable

Direct Known Subclasses:

MemoryMapCacheEngine

public abstract class ScheduledCacheEngine
extends AbstractCacheEngine
implements Runnable

This abstract engine is able to clear its cache in a particular interval.

Since:

0.4.0

Version:

1.1

Author:

Guillaume DROUET

Nested Class Summary

Nested classes/interfaces inherited from class com.github.wuic.engine.core.AbstractCacheEngine

AbstractCacheEngine.CacheResult

Constructor Summary

Constructors

Constructor and Description
ScheduledCacheEngine(int timeToLiveSeconds, Boolean cache, Boolean bestEffort) Creates a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	clearCache() Clears this cache.
void	run()
void	setTimeToLive(int timeToLiveSeconds) Schedules the time to live for this cache.

Methods inherited from class com.github.wuic.engine.core.AbstractCacheEngine

getEngineType, getFromCache, internalParse, parse, putToCache, removeFromCache, works

Methods inherited from class com.github.wuic.engine.HeadEngine

parse, runChains

Methods inherited from class com.github.wuic.engine.Engine

compareTo

Methods inherited from class java.lang.Object

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

Constructor Detail

ScheduledCacheEngine

public ScheduledCacheEngine(int timeToLiveSeconds,
                    Boolean cache,
                    Boolean bestEffort)

Creates a new instance.

Parameters:

timeToLiveSeconds - time to live in seconds for this cache

cache - if cache is activated or not

bestEffort - enable best effort mode or not

Method Detail

setTimeToLive

public final void setTimeToLive(int timeToLiveSeconds)

Schedules the time to live for this cache. If the specified value is a positive number, a thread will be executed at the specified interval to clear the cache. Otherwise, any scheduled operation will be canceled.

Parameters:

timeToLiveSeconds - new time to live of cache in seconds

run

public void run()

Specified by:

run in interface Runnable

clearCache

protected abstract void clearCache()

Clears this cache.