|
ehcache | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.ehcache.store.AbstractStore net.sf.ehcache.store.LegacyStoreWrapper
public class LegacyStoreWrapper
A wrapper to convert a legacy pair of stores into a new style compound store.
Field Summary |
---|
Fields inherited from class net.sf.ehcache.store.AbstractStore |
---|
attributeExtractors, searchManager |
Fields inherited from interface net.sf.ehcache.store.Store |
---|
CLUSTER_COHERENT, NODE_COHERENT |
Constructor Summary | |
---|---|
LegacyStoreWrapper(Store memory,
Store disk,
RegisteredEventListeners eventListeners,
CacheConfiguration config)
Create a correctly locked store wrapper around the supplied in-memory and on disk stores. |
Method Summary | |
---|---|
boolean |
bufferFull()
Some store types, such as the disk stores can fill their write buffers if puts come in too fast. |
boolean |
containsKey(Object key)
A check to see if a key is in the Store. |
boolean |
containsKeyInMemory(Object key)
A check to see if a key is in the Store and is currently held in memory. |
boolean |
containsKeyOffHeap(Object key)
A check to see if a key is in the Store and is currently held off-heap. |
boolean |
containsKeyOnDisk(Object key)
A check to see if a key is in the Store and is currently held on disk. |
void |
dispose()
Prepares for shutdown. |
void |
expireElements()
Expire all elements. |
void |
flush()
Flush elements to persistent store. |
Element |
get(Object key)
Gets an item from the cache. |
Policy |
getInMemoryEvictionPolicy()
|
int |
getInMemorySize()
Returns the current local in-memory store size |
long |
getInMemorySizeInBytes()
Gets the size of the in-memory portion of the store, in bytes. |
Object |
getInternalContext()
This should not be used, and will generally return null |
List |
getKeys()
Gets an Array of the keys for all elements in the disk store. |
Object |
getMBean()
Optional implementation specific MBean exposed by the store. |
Store |
getMemoryStore()
Returns the underlying memory store for this legacy wrapper. |
int |
getOffHeapSize()
Returns the current local off-heap store size |
long |
getOffHeapSizeInBytes()
Gets the size of the off-heap portion of the store, in bytes. |
int |
getOnDiskSize()
Returns the current local on-disk store size |
long |
getOnDiskSizeInBytes()
Gets the size of the on-disk portion of the store, in bytes. |
Element |
getQuiet(Object key)
Gets an Element from the Store, without updating statistics |
int |
getSize()
Returns the current local store size |
Status |
getStatus()
Returns the cache status. |
int |
getTerracottaClusteredSize()
Returns the current Terracotta clustered store size |
boolean |
put(Element element)
Puts an item into the store. |
Element |
putIfAbsent(Element element)
Put an element in the store if no element is currently mapped to the elements key. |
boolean |
putWithWriter(Element element,
CacheWriterManager writerManager)
Puts an item into the store and the cache writer manager in an atomic operation |
Element |
remove(Object key)
Removes an item from the cache. |
void |
removeAll()
Remove all of the elements from the store. |
Element |
removeElement(Element element,
ElementValueComparator comparator)
Remove the Element mapped to the key for the supplied element if the value of the supplied Element is equal to the value of the cached Element. |
Element |
removeWithWriter(Object key,
CacheWriterManager writerManager)
Removes an item from the store and the cache writer manager in an atomic operation. |
Element |
replace(Element element)
Replace the cached element only if an Element is currently cached for this key |
boolean |
replace(Element old,
Element element,
ElementValueComparator comparator)
Replace the cached element only if the value of the current Element is equal to the value of the supplied old Element. |
void |
setInMemoryEvictionPolicy(Policy policy)
Sets the eviction policy strategy. |
Methods inherited from class net.sf.ehcache.store.AbstractStore |
---|
addStoreListener, executeQuery, getAll, getAllQuiet, getEventListenerList, getSearchAttribute, getSearchAttributes, hasAbortedSizeOf, isCacheCoherent, isClusterCoherent, isNodeCoherent, putAll, recalculateSize, removeAll, removeStoreListener, setAttributeExtractors, setNodeCoherent, waitUntilClusterCoherent |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public LegacyStoreWrapper(Store memory, Store disk, RegisteredEventListeners eventListeners, CacheConfiguration config)
memory
- in-memory storedisk
- on disk storeeventListeners
- event listener to fire onconfig
- cache configurationMethod Detail |
---|
public boolean bufferFull()
public boolean containsKey(Object key)
key
- The Element key
public boolean containsKeyInMemory(Object key)
key
- The Element key
public boolean containsKeyOffHeap(Object key)
key
- The Element key
public boolean containsKeyOnDisk(Object key)
key
- The Element key
public void dispose()
public void expireElements()
public void flush() throws IOException
IOException
- if any IO error occurspublic Element get(Object key)
public Policy getInMemoryEvictionPolicy()
Store.setInMemoryEvictionPolicy(Policy)
public int getInMemorySize()
public long getInMemorySizeInBytes()
public Object getInternalContext()
public List getKeys()
Serializable
keyspublic int getOffHeapSize()
public long getOffHeapSizeInBytes()
public int getOnDiskSize()
public long getOnDiskSizeInBytes()
public Element getQuiet(Object key)
Element
from the Store, without updating statistics
public int getSize()
Element
s in the memory store
plus the number of Element
s in the disk store.
public Status getStatus()
public int getTerracottaClusteredSize()
public boolean put(Element element) throws CacheException
CacheException
public boolean putWithWriter(Element element, CacheWriterManager writerManager) throws CacheException
CacheException
public Element remove(Object key)
public void removeAll() throws CacheException
CacheEventListener
s they are notified of the expiry or removal
of the Element
as each is removed.
CacheException
public Element removeWithWriter(Object key, CacheWriterManager writerManager) throws CacheException
CacheException
public void setInMemoryEvictionPolicy(Policy policy)
policy
- the new policypublic Store getMemoryStore()
public Element putIfAbsent(Element element) throws NullPointerException
element
- element to be added
NullPointerException
- if the element is null, or has a null keypublic Element removeElement(Element element, ElementValueComparator comparator) throws NullPointerException
element
- Element to be removedcomparator
- ElementValueComparator to use to compare elements
NullPointerException
- if the element is null, or has a null keypublic boolean replace(Element old, Element element, ElementValueComparator comparator) throws NullPointerException, IllegalArgumentException
old
- Element to be test againstelement
- Element to be cachedcomparator
- ElementValueComparator to use to compare elements
NullPointerException
- if the either Element is null or has a null key
IllegalArgumentException
- if the two Element keys are non-null but not equalpublic Element replace(Element element) throws NullPointerException
element
- Element to be cached
NullPointerException
- if the Element is null or has a null keypublic Object getMBean()
|
ehcache | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |