com.codelanx.codelanxlib.util.cache

Class WeakCache<E>

java.lang.Object

com.codelanx.codelanxlib.util.cache.WeakCache<E>

Type Parameters:

E - The type of the cached variable

public class WeakCache<E>
extends Object

Represents a single variable which will be dynamically updated upon an internal WeakReference being null upon accessing

Since:

0.1.0

Version:

0.1.0

Author:

1Rogue

Constructor Summary

Constructors

Constructor and Description
WeakCache(Supplier<? extends E> update) Stores the Supplier for the cached value
WeakCache(Supplier<? extends E> update, boolean forceRefresh) Stores the Supplier for the cached value

Method Summary

Modifier and Type	Method and Description
void	forceRefresh() Forcibly refreshes the current value of this WeakCache
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 WeakCache

Methods inherited from class java.lang.Object

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

Constructor Detail

WeakCache

public WeakCache(Supplier<? extends E> update)

Stores the Supplier for the cached value

Parameters:

update - Called when a cached value is null

Since:

0.1.0

WeakCache

public WeakCache(Supplier<? extends E> update,
                 boolean forceRefresh)

Stores the Supplier for the cached value

Parameters:

update - Called when a cached value is null

forceRefresh - true to refresh and retrieve the cached instance upon construction, instead of on the first call to Cache.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 WeakCache

Since:

0.1.0

getCurrentValue

protected E getCurrentValue()

Returns the currently in-use variable without checking the cache

Returns:

The current value of this WeakCache

Since:

0.1.0

setCurrentValue

protected void setCurrentValue(E value)

Sets the value of this WeakCache

Parameters:

value - The new value to set

Since:

0.1.0

forceRefresh

public final void forceRefresh()

Forcibly refreshes the current value of this WeakCache

Since:

0.1.0