jhelp.util.cache

Class Cache<ELEMENT>

java.lang.Object

jhelp.util.cache.Cache<ELEMENT>

Type Parameters:

ELEMENT - Element type

public class Cache<ELEMENT>
extends java.lang.Object

Manage a only RAM cache

Last modification : 13 avr. 2010
Version 0.0.0

Author:

JHelp

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.HashMap<java.lang.String,CacheElement<ELEMENT>>	cache The cache itself

Constructor Summary

Constructors

Constructor and Description
Cache() Constructs Cache

Method Summary

Methods

Modifier and Type	Method and Description
void	add(java.lang.String key, CacheElement<ELEMENT> element) Add element inside the cache
void	clear() Clear the cache
void	destroy() Destroy the cache (Never use it after that)
ELEMENT	get(java.lang.String key) Obtain an element
ELEMENT	get(java.lang.String key, CacheElement<ELEMENT> cacheElement) Obtain an element and give a default value if key is not already present
void	remove(java.lang.String key) Remove an element from cache

Methods inherited from class java.lang.Object

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

Field Detail

cache

private java.util.HashMap<java.lang.String,CacheElement<ELEMENT>> cache

The cache itself

Constructor Detail

Cache

public Cache()

Constructs Cache

Method Detail

add

public void add(java.lang.String key,
       CacheElement<ELEMENT> element)

Add element inside the cache

Parameters:

key - Key associate

element - Describe how create element

clear

public void clear()

Clear the cache

destroy

public void destroy()

Destroy the cache (Never use it after that)

get

public ELEMENT get(java.lang.String key)

Obtain an element

Parameters:

key - Element key

Returns:

Element

get

public ELEMENT get(java.lang.String key,
          CacheElement<ELEMENT> cacheElement)

Obtain an element and give a default value if key is not already present

Parameters:

key - Key to get

cacheElement - Cache element to store and use if the key is not already defined

Returns:

The element

remove

public void remove(java.lang.String key)

Remove an element from cache

Parameters:

key - Element key