com.codelanx.commons.util.cache

Class Cache<E>

java.lang.Object

com.codelanx.commons.util.cache.Cache<E>

Type Parameters:

E - The type of the cached variable

public abstract class Cache<E>
extends Object

Represents a single variable which will be dynamically updated upon regular intervals of retrieval

Since:

0.1.0

Version:

0.1.0

Author:

1Rogue

Constructor Summary

Constructors

Constructor and Description
Cache(long timeMS) Notes the timed intervals in milliseconds for cache refreshing, and refreshes the cache for the first time
Cache(long timeMS, boolean forceRefresh) Notes the timed intervals in milliseconds for cache refreshing, and refreshes the cache for the first time

Method Summary

Modifier and Type	Method and Description
void	forceRefresh() Forcibly refreshes the current value of this Cache
E	get() Calls a check to see if the cache needs to be updated, and returns the stored variable
protected E	getCurrentValue() Returns the currently in-use variable without checking the cache
protected void	setCurrentValue(E value) Sets the value of this Cache
protected abstract void	update() Called when a variable needs to be updated.

Methods inherited from class java.lang.Object

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

Constructor Detail

Cache

public Cache(long timeMS)

Notes the timed intervals in milliseconds for cache refreshing, and refreshes the cache for the first time

Parameters:

timeMS - The time to wait between refreshes in milliseconds

Since:

0.1.0

Cache

public Cache(long timeMS,
             boolean forceRefresh)

Notes the timed intervals in milliseconds for cache refreshing, and refreshes the cache for the first time

Parameters:

timeMS - The time to wait between refreshes in milliseconds

forceRefresh - true to refresh and retrieve the cached instance upon construction, instead of on the first call to get()

Since:

0.1.0

Method Detail

get

public final E get()

Calls a check to see if the cache needs to be updated, and returns the stored variable

Returns:

The stored value of this Cache

Since:

0.1.0

update

protected abstract void update()

Called when a variable needs to be updated.

Since:

0.1.0

getCurrentValue

protected E getCurrentValue()

Returns the currently in-use variable without checking the cache

Returns:

The current value of this Cache

Since:

0.1.0

setCurrentValue

protected void setCurrentValue(E value)

Sets the value of this Cache

Parameters:

value - The new value to set

Since:

0.1.0

forceRefresh

public final void forceRefresh()

Forcibly refreshes the current value of this Cache

Since:

0.1.0