org.myrobotlab.memory

Class BaseCache

java.lang.Object

org.myrobotlab.memory.BaseCache

All Implemented Interfaces:

Cache, ManagedCache

Direct Known Subclasses:

LocalCache

public abstract class BaseCache
extends Object
implements ManagedCache

Base class that contains the public facing methods.

Author:

SwedaKonsult

Constructor Summary

Constructors

Constructor and Description
BaseCache()

Method Summary

Modifier and Type	Method and Description
protected abstract void	addToCache(String name, Object value) Internal method for BaseCache to actually add items to the implementing cache.
void	clear() Clear all values from the cache.
protected abstract void	clearCache()
protected abstract boolean	contains(String name) Internal method for BaseCache to actually check if the name exists in the implementing cache.
void	expire(String name) Expire an item in the cache.
protected abstract void	expireItem(String name)
<T> T	get(String name, Class<? extends T> cls) Get a value from the cache.
boolean	getBool(String name)
byte	getByte(String name)
double	getDouble(String name)
float	getFloat(String name)
protected abstract Object	getFromCache(String name) Internal method for BaseCache to actually retrieve items from the implementing cache.
int	getInt(String name)
short	getShort(String name)
void	put(String name, Object value) Add a value to the cache.
protected abstract void	removeFromCache(String name) Internal method for BaseCache to actually remove items from the implementing cache.
void	timeout() Clear out any values that should be timed out.
protected abstract void	timeoutCache()

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseCache

public BaseCache()

Method Detail

addToCache

protected abstract void addToCache(String name,
                                   Object value)

Internal method for BaseCache to actually add items to the implementing cache.

Parameters:

name -

value -

clear

public void clear()

Description copied from interface: ManagedCache

Clear all values from the cache.

Specified by:

clear in interface ManagedCache

clearCache

protected abstract void clearCache()

contains

protected abstract boolean contains(String name)

Internal method for BaseCache to actually check if the name exists in the implementing cache.

Parameters:

name -

Returns:

expire

public void expire(String name)

Expire an item in the cache.

Specified by:

expire in interface Cache

Specified by:

expire in interface ManagedCache

Parameters:

name - the name

expireItem

protected abstract void expireItem(String name)

get

public <T> T get(String name,
                 Class<? extends T> cls)

Get a value from the cache.

Specified by:

get in interface Cache

Parameters:

name - the name of the value to retrieve

Returns:

null if the name does not exist or if the type could not be cast to T

getBool

public boolean getBool(String name)

getByte

public byte getByte(String name)

getDouble

public double getDouble(String name)

getFloat

public float getFloat(String name)

getFromCache

protected abstract Object getFromCache(String name)

Internal method for BaseCache to actually retrieve items from the implementing cache.

Parameters:

name -

getInt

public int getInt(String name)

getShort

public short getShort(String name)

put

public void put(String name,
                Object value)

Add a value to the cache.

Specified by:

put in interface Cache

Parameters:

name - cannot be null or empty

value - the value of the item

removeFromCache

protected abstract void removeFromCache(String name)

Internal method for BaseCache to actually remove items from the implementing cache.

Parameters:

name -

timeout

public void timeout()

Description copied from interface: ManagedCache

Clear out any values that should be timed out.

Specified by:

timeout in interface ManagedCache

timeoutCache

protected abstract void timeoutCache()