org.jsr107.ri

Class RICache<K,V>

java.lang.Object

org.jsr107.ri.RICache<K,V>

Type Parameters:

K - the type of keys maintained by this map

V - the type of mapped values*

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<javax.cache.Cache.Entry<K,V>>, javax.cache.Cache<K,V>

public final class RICache<K,V>
extends Object
implements javax.cache.Cache<K,V>

The reference implementation for JSR107.

This is meant to act as a proof of concept for the API. It is not threadsafe or high performance and does limit the size of caches or provide eviction. It therefore is not suitable for use in production. Please use a production implementation of the API.

Author:

Brian Oliver, Greg Luck, Yannis Cosmadopoulos

Nested Class Summary

Nested classes/interfaces inherited from interface javax.cache.Cache

javax.cache.Cache.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
void	clear()
void	close()
boolean	containsKey(K key)
void	deregisterCacheEntryListener(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration)
V	get(K key)
Map<K,V>	getAll(Set<? extends K> keys)
V	getAndPut(K key, V value)
V	getAndRemove(K key)
V	getAndReplace(K key, V value)
javax.cache.CacheManager	getCacheManager()
javax.cache.management.CacheMXBean	getCacheMXBean()
javax.cache.management.CacheStatisticsMXBean	getCacheStatisticsMXBean()
<C extends javax.cache.configuration.Configuration<K,V>> C	getConfiguration(Class<C> clazz)
protected javax.cache.expiry.Duration	getDefaultDuration() The default Duration to use when a Duration can't be determined.
String	getName()
long	getSize() Returns the size of the cache.
<T> T	invoke(K key, javax.cache.processor.EntryProcessor<K,V,T> entryProcessor, Object... arguments)
<T> Map<K,javax.cache.processor.EntryProcessorResult<T>>	invokeAll(Set<? extends K> keys, javax.cache.processor.EntryProcessor<K,V,T> entryProcessor, Object... arguments)
boolean	isClosed()
Iterator<javax.cache.Cache.Entry<K,V>>	iterator()
void	loadAll(Set<? extends K> keys, boolean replaceExistingValues, javax.cache.integration.CompletionListener completionListener)
void	put(K key, V value)
void	putAll(Map<? extends K,? extends V> map)
void	putAll(Map<? extends K,? extends V> map, boolean replaceExistingValues)
void	putAll(Map<? extends K,? extends V> map, boolean replaceExistingValues, boolean useWriteThrough) A implementation of PutAll that allows optional replacement of existing values and optionally writing values when Write Through is configured.
boolean	putIfAbsent(K key, V value)
void	registerCacheEntryListener(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration)
boolean	remove(K key)
boolean	remove(K key, V oldValue)
void	removeAll()
void	removeAll(Set<? extends K> keys)
boolean	replace(K key, V value)
boolean	replace(K key, V oldValue, V newValue)
void	setManagementEnabled(boolean enabled) Sets management enablement
void	setStatisticsEnabled(boolean enabled) Sets statistics
protected void	submit(Runnable task) Requests a Runnable to be performed.
<T> T	unwrap(Class<T> cls)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

submit

protected void submit(Runnable task)

Requests a Runnable to be performed.

Parameters:

task - the Runnable to be performed

getDefaultDuration

protected javax.cache.expiry.Duration getDefaultDuration()

The default Duration to use when a Duration can't be determined.

Returns:

the default Duration

getName

public String getName()

Specified by:

getName in interface javax.cache.Cache<K,V>

getCacheManager

public javax.cache.CacheManager getCacheManager()

Specified by:

getCacheManager in interface javax.cache.Cache<K,V>

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface javax.cache.Cache<K,V>

isClosed

public boolean isClosed()

Specified by:

isClosed in interface javax.cache.Cache<K,V>

getConfiguration

public <C extends javax.cache.configuration.Configuration<K,V>> C getConfiguration(Class<C> clazz)

Specified by:

getConfiguration in interface javax.cache.Cache<K,V>

get

public V get(K key)

Specified by:

get in interface javax.cache.Cache<K,V>

getAll

public Map<K,V> getAll(Set<? extends K> keys)

Specified by:

getAll in interface javax.cache.Cache<K,V>

containsKey

public boolean containsKey(K key)

Specified by:

containsKey in interface javax.cache.Cache<K,V>

loadAll

public void loadAll(Set<? extends K> keys,
                    boolean replaceExistingValues,
                    javax.cache.integration.CompletionListener completionListener)

Specified by:

loadAll in interface javax.cache.Cache<K,V>

put

public void put(K key,
                V value)

Specified by:

put in interface javax.cache.Cache<K,V>

getAndPut

public V getAndPut(K key,
                   V value)

Specified by:

getAndPut in interface javax.cache.Cache<K,V>

putAll

public void putAll(Map<? extends K,? extends V> map)

Specified by:

putAll in interface javax.cache.Cache<K,V>

putAll

public void putAll(Map<? extends K,? extends V> map,
                   boolean replaceExistingValues)

putAll

public void putAll(Map<? extends K,? extends V> map,
                   boolean replaceExistingValues,
                   boolean useWriteThrough)

A implementation of PutAll that allows optional replacement of existing values and optionally writing values when Write Through is configured.

Parameters:

map - the Map of entries to put

replaceExistingValues - should existing values be replaced by those in the map?

useWriteThrough - should write-through be used if it is configured

putIfAbsent

public boolean putIfAbsent(K key,
                           V value)

Specified by:

putIfAbsent in interface javax.cache.Cache<K,V>

remove

public boolean remove(K key)

Specified by:

remove in interface javax.cache.Cache<K,V>

remove

public boolean remove(K key,
                      V oldValue)

Specified by:

remove in interface javax.cache.Cache<K,V>

getAndRemove

public V getAndRemove(K key)

Specified by:

getAndRemove in interface javax.cache.Cache<K,V>

replace

public boolean replace(K key,
                       V oldValue,
                       V newValue)

Specified by:

replace in interface javax.cache.Cache<K,V>

replace

public boolean replace(K key,
                       V value)

Specified by:

replace in interface javax.cache.Cache<K,V>

getAndReplace

public V getAndReplace(K key,
                       V value)

Specified by:

getAndReplace in interface javax.cache.Cache<K,V>

removeAll

public void removeAll(Set<? extends K> keys)

Specified by:

removeAll in interface javax.cache.Cache<K,V>

removeAll

public void removeAll()

Specified by:

removeAll in interface javax.cache.Cache<K,V>

clear

public void clear()

Specified by:

clear in interface javax.cache.Cache<K,V>

invoke

public <T> T invoke(K key,
                    javax.cache.processor.EntryProcessor<K,V,T> entryProcessor,
                    Object... arguments)

Specified by:

invoke in interface javax.cache.Cache<K,V>

invokeAll

public <T> Map<K,javax.cache.processor.EntryProcessorResult<T>> invokeAll(Set<? extends K> keys,
                                                                          javax.cache.processor.EntryProcessor<K,V,T> entryProcessor,
                                                                          Object... arguments)

Specified by:

invokeAll in interface javax.cache.Cache<K,V>

iterator

public Iterator<javax.cache.Cache.Entry<K,V>> iterator()

Specified by:

iterator in interface Iterable<javax.cache.Cache.Entry<K,V>>

Specified by:

iterator in interface javax.cache.Cache<K,V>

getCacheMXBean

public javax.cache.management.CacheMXBean getCacheMXBean()

Returns:

the managemtn bean

getCacheStatisticsMXBean

public javax.cache.management.CacheStatisticsMXBean getCacheStatisticsMXBean()

Returns:

the managemtn bean

setStatisticsEnabled

public void setStatisticsEnabled(boolean enabled)

Sets statistics

setManagementEnabled

public void setManagementEnabled(boolean enabled)

Sets management enablement

Parameters:

enabled - true if management should be enabled

unwrap

public <T> T unwrap(Class<T> cls)

Specified by:

unwrap in interface javax.cache.Cache<K,V>

registerCacheEntryListener

public void registerCacheEntryListener(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration)

Specified by:

registerCacheEntryListener in interface javax.cache.Cache<K,V>

deregisterCacheEntryListener

public void deregisterCacheEntryListener(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration)

Specified by:

deregisterCacheEntryListener in interface javax.cache.Cache<K,V>

getSize

public long getSize()

Returns the size of the cache.

Returns:

the size in entries of the cache