net.sf.ehcache.store
Interface TierableStore

All Superinterfaces:

Store

All Known Implementing Classes:

DiskStore, MemoryStore, NotifyingMemoryStore, NullStore

public interface TierableStore
extends Store

This is the interface for all tierable stores.

Author:

Ludovic Orban

Field Summary

Fields inherited from interface net.sf.ehcache.store.Store

CLUSTER_COHERENT, NODE_COHERENT

Method Summary

void	fill(Element e) Add this element to the cache if the key is already present or the add can succeed without resorting to eviction.
Set	getPresentPinnedKeys() Returns all the keys that are pinned, for which there is a mapping present
boolean	isPersistent() Is this store persistent (data survives a JVM restart)
boolean	isTierPinned() Is this TierableStore pinned ?
boolean	removeIfNotPinned(Object key) This method will only remove if the element or the store is not pinned and the key is present in the store
void	removeNoReturn(Object key) Removes an item from the cache.

Methods inherited from interface net.sf.ehcache.store.Store

addStoreListener, bufferFull, containsKey, containsKeyInMemory, containsKeyOffHeap, containsKeyOnDisk, dispose, executeQuery, expireElements, flush, get, getAll, getAllQuiet, getInMemoryEvictionPolicy, getInMemorySize, getInMemorySizeInBytes, getInternalContext, getKeys, getMBean, getOffHeapSize, getOffHeapSizeInBytes, getOnDiskSize, getOnDiskSizeInBytes, getQuiet, getSearchAttribute, getSize, getStatus, getTerracottaClusteredSize, hasAbortedSizeOf, isCacheCoherent, isClusterCoherent, isNodeCoherent, isPinned, put, putAll, putIfAbsent, putWithWriter, recalculateSize, remove, removeAll, removeAll, removeElement, removeStoreListener, removeWithWriter, replace, replace, setAttributeExtractors, setInMemoryEvictionPolicy, setNodeCoherent, setPinned, unpinAll, waitUntilClusterCoherent

Method Detail

fill

void fill(Element e)

Add this element to the cache if the key is already present or the add can succeed without resorting to eviction.

Parameters:

e - element to be added

removeIfNotPinned

boolean removeIfNotPinned(Object key)

This method will only remove if the element or the store is not pinned and the key is present in the store

Parameters:

key - the key to the element

Returns:

true if an element was removed

See Also:

Store.remove(Object)

removeNoReturn

void removeNoReturn(Object key)

Removes an item from the cache.

isTierPinned

boolean isTierPinned()

Is this TierableStore pinned ?

Returns:

true if pinned

getPresentPinnedKeys

Set getPresentPinnedKeys()

Returns all the keys that are pinned, for which there is a mapping present

Returns:

the set of keys with values that are currently pinned

isPersistent

boolean isPersistent()

Is this store persistent (data survives a JVM restart)

Returns:

true if persistent