|
ehcache | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectnet.sf.ehcache.store.AbstractStore
net.sf.ehcache.store.NullStore
public final class NullStore
A store implementation which does not store anything.
| Field Summary |
|---|
| Fields inherited from class net.sf.ehcache.store.AbstractStore |
|---|
attributeExtractors |
| Fields inherited from interface net.sf.ehcache.store.Store |
|---|
CLUSTER_COHERENT, NODE_COHERENT |
| 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. |
static NullStore |
create()
Create a new NullStore instance. |
void |
dispose()
Prepares for shutdown. |
void |
expireElements()
Expire all elements. |
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. |
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. |
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. |
Set |
getPresentPinnedKeys()
Returns all the keys that are pinned, for which there is a mapping present |
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 |
isPersistent()
Is this store persistent (data survives a JVM restart) |
boolean |
isPinned(Object key)
Check if the key is pinned |
boolean |
isTierPinned()
Is this TierableStore pinned ? |
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 |
void |
recalculateSize(Object key)
Recalculate size of the element mapped to the key |
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. |
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. |
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. |
void |
setPinned(Object key,
boolean pinned)
Mark the key as pinned or not |
void |
unpinAll()
unpin all pinned keys |
| Methods inherited from class net.sf.ehcache.store.AbstractStore |
|---|
addStoreListener, executeQuery, getAll, getAllQuiet, getEventListenerList, getSearchAttribute, hasAbortedSizeOf, isCacheCoherent, isClusterCoherent, isNodeCoherent, putAll, removeAll, removeStoreListener, setAttributeExtractors, setNodeCoherent, waitUntilClusterCoherent |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface net.sf.ehcache.store.Store |
|---|
addStoreListener, executeQuery, getAll, getAllQuiet, getSearchAttribute, hasAbortedSizeOf, isCacheCoherent, isClusterCoherent, isNodeCoherent, putAll, removeAll, removeStoreListener, setAttributeExtractors, setNodeCoherent, waitUntilClusterCoherent |
| Method Detail |
|---|
public static NullStore create()
public void unpinAll()
unpinAll in interface Storepublic boolean isPinned(Object key)
isPinned in interface Storekey - the key to be checked
true if the element is pinned
public void setPinned(Object key,
boolean pinned)
setPinned in interface Storekey - the key to be pinned or notpinned - true if the key should be pinned, false otherwise
public boolean put(Element element)
throws CacheException
put in interface StoreCacheException
public boolean putWithWriter(Element element,
CacheWriterManager writerManager)
throws CacheException
putWithWriter in interface StoreCacheExceptionpublic Element get(Object key)
get in interface Storepublic Element getQuiet(Object key)
Element from the Store, without updating statistics
getQuiet in interface Storepublic List getKeys()
getKeys in interface StoreSerializable keyspublic Element remove(Object key)
remove in interface Storepublic void removeNoReturn(Object key)
removeNoReturn in interface TierableStorepublic boolean isTierPinned()
isTierPinned in interface TierableStorepublic Set getPresentPinnedKeys()
getPresentPinnedKeys in interface TierableStorepublic boolean isPersistent()
isPersistent in interface TierableStore
public Element removeWithWriter(Object key,
CacheWriterManager writerManager)
throws CacheException
removeWithWriter in interface StoreCacheException
public void removeAll()
throws CacheException
CacheEventListeners they are notified of the expiry or removal
of the Element as each is removed.
removeAll in interface StoreCacheException
public Element putIfAbsent(Element element)
throws NullPointerException
putIfAbsent in interface Storeelement - element to be added
NullPointerException - if the element is null, or has a null key
public Element removeElement(Element element,
ElementValueComparator comparator)
throws NullPointerException
removeElement in interface Storeelement - Element to be removedcomparator - ElementValueComparator to use to compare elements
NullPointerException - if the element is null, or has a null key
public boolean replace(Element old,
Element element,
ElementValueComparator comparator)
throws NullPointerException,
IllegalArgumentException
replace in interface Storeold - 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 equal
public Element replace(Element element)
throws NullPointerException
replace in interface Storeelement - Element to be cached
NullPointerException - if the Element is null or has a null keypublic void dispose()
dispose in interface Storepublic int getSize()
getSize in interface Storepublic int getInMemorySize()
getInMemorySize in interface Storepublic int getOffHeapSize()
getOffHeapSize in interface Storepublic int getOnDiskSize()
getOnDiskSize in interface Storepublic int getTerracottaClusteredSize()
getTerracottaClusteredSize in interface Storepublic long getInMemorySizeInBytes()
getInMemorySizeInBytes in interface Storepublic long getOffHeapSizeInBytes()
getOffHeapSizeInBytes in interface Storepublic long getOnDiskSizeInBytes()
getOnDiskSizeInBytes in interface Storepublic Status getStatus()
getStatus in interface Storepublic boolean containsKey(Object key)
containsKey in interface Storekey - The Element key
public boolean containsKeyOnDisk(Object key)
containsKeyOnDisk in interface Storekey - The Element key
public boolean containsKeyOffHeap(Object key)
containsKeyOffHeap in interface Storekey - The Element key
public boolean containsKeyInMemory(Object key)
containsKeyInMemory in interface Storekey - The Element key
public void expireElements()
expireElements in interface Store
public void flush()
throws IOException
flush in interface StoreIOException - if any IO error occurspublic boolean bufferFull()
bufferFull in interface Storepublic Policy getInMemoryEvictionPolicy()
getInMemoryEvictionPolicy in interface StoreStore.setInMemoryEvictionPolicy(Policy)public void setInMemoryEvictionPolicy(Policy policy)
setInMemoryEvictionPolicy in interface Storepolicy - the new policypublic Object getInternalContext()
getInternalContext in interface Storepublic Object getMBean()
getMBean in interface Storepublic void fill(Element e)
fill in interface TierableStoree - element to be addedpublic boolean removeIfNotPinned(Object key)
removeIfNotPinned in interface TierableStorekey - the key to the element
Store.remove(Object)public void recalculateSize(Object key)
recalculateSize in interface StorerecalculateSize in class AbstractStorekey - the key
|
ehcache | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||