A B C D E F G I L N P R S T U W

A

acquireReadLockOnKey(Object) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Acquires the proper read lock for a given cache key

acquireWriteLockOnKey(Object) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Acquires the proper write lock for a given cache key

B

bootstrap() - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Bootstrap command.

C

cache - Variable in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

The backing Cache

calculateInMemorySize() - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Gets the size of the memory store for this cache

Warning: This method can be very expensive to run.

clearStatistics() - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Resets statistics counters back to 0.

clone() - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Clones a cache.

D

disableDynamicFeatures() - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

dispose() - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Flushes all cache items from memory to auxilliary caches and close the auxilliary caches.

E

evictExpiredElements() - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Causes all elements stored in the Cache to be synchronously checked for expiry, and if expired, evicted.

ExplicitLockingCache - Class in net.sf.ehcache.constructs.locking

See description in package.html

ExplicitLockingCache(Ehcache) - Constructor for class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Constructor for this decorated cache

F

flush() - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Flushes all cache items from memory to the disk store, and from the DiskStore to disk.

G

get(Object) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Looks up an entry.

get(Serializable) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Gets an element from the cache.

getAllWithLoader(Collection, Object) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

This method is not appropriate to use with BlockingCache.

getAverageGetTime() - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

The average get time in ms.

getBootstrapCacheLoader() - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Accessor for the BootstrapCacheLoader associated with this cache.

getCache() - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Retrieve the EHCache backing cache

getCacheConfiguration() - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Gets the cache configuration this cache was created with.

getCacheEventNotificationService() - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Use this to access the service in order to register and unregister listeners

getCacheExceptionHandler() - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Sets an ExceptionHandler on the Cache.

getCacheManager() - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Gets the CacheManager managing this cache.

getDiskStoreSize() - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Returns the number of elements in the disk store.

getGuid() - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

The GUID for this cache instance can be used to determine whether two cache instance references are pointing to the same cache.

getInternalContext() - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

getKeys() - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Returns the keys for this cache.

getKeysNoDuplicateCheck() - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Returns a list of all elements in the cache, whether or not they are expired.

getKeysWithExpiryCheck() - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Returns a list of all elements in the cache.

getLiveCacheStatistics() - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

getLockForKey(Object) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Gets the lock for a given key

getMemoryStoreSize() - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Returns the number of elements in the memory store.

getName() - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Returns this cache's name

getQuiet(Serializable) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Gets an element from the cache, without updating Element statistics.

getQuiet(Object) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Gets an element from the cache, without updating Element statistics.

getRegisteredCacheExtensions() - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

getRegisteredCacheLoaders() - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

getRegisteredCacheWriter() - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

getSampledCacheStatistics() - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

getSize() - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Gets the size of the cache.

getSizeBasedOnAccuracy(int) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

getStatistics() - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Gets an immutable Statistics object representing the Cache statistics at the time.

getStatisticsAccuracy() - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Accurately measuring statistics can be expensive.

getStatus() - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Gets the status attribute of the Cache.

getWithLoader(Object, CacheLoader, Object) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

This method is not appropriate to use with BlockingCache.

getWriterManager() - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

I

initialise() - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

This method creates a memory or disk store and makes the cache ready to accept elements

isClusterCoherent() - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

isDisabled() - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Whether this cache is disabled.

isElementInMemory(Serializable) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Whether an Element is stored in the cache in Memory, indicating a very low cost of retrieval.

isElementInMemory(Object) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Whether an Element is stored in the cache in Memory, indicating a very low cost of retrieval.

isElementOnDisk(Serializable) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Whether an Element is stored in the cache on Disk, indicating a higher cost of retrieval.

isElementOnDisk(Object) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Whether an Element is stored in the cache on Disk, indicating a higher cost of retrieval.

isExpired(Element) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Checks whether this cache element has expired.

isKeyInCache(Object) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

An inexpensive check to see if the key exists in the cache.

isNodeCoherent() - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

isSampledStatisticsEnabled() - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

isStatisticsEnabled() - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

isValueInCache(Object) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

An extremely expensive check to see if the value exists in the cache.

L

liveness() - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Synchronized version of getName to test liveness of the object lock.

load(Object) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

This method is not appropriate to use with BlockingCache.

loadAll(Collection, Object) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

This method is not appropriate to use with BlockingCache.

N

net.sf.ehcache.constructs.locking - package net.sf.ehcache.constructs.locking

This package contains an implementation of an Ehcache which provides for explicit locking, using READ and WRITE locks.

P

put(Element) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Adds an entry and unlocks it

put(Element, boolean) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Put an element in the cache.

putIfAbsent(Element) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Put an element in the cache if an element for the key doesn't already exist

putQuiet(Element) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Put an element in the cache, without updating statistics, or updating listeners.

putWithWriter(Element) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

R

registerCacheExtension(CacheExtension) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Register a CacheExtension with the cache.

registerCacheLoader(CacheLoader) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Register a CacheLoader with the cache.

registerCacheUsageListener(CacheUsageListener) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

registerCacheWriter(CacheWriter) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

releaseReadLockOnKey(Object) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Release a held read lock for the passed in key

releaseWriteLockOnKey(Object) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Release a held write lock for the passed in key

remove(Serializable) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Removes an Element from the Cache.

remove(Object) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Removes an Element from the Cache.

remove(Serializable, boolean) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Removes an Element from the Cache.

remove(Object, boolean) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Removes an Element from the Cache.

removeAll() - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Removes all cached items.

removeAll(boolean) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Removes all cached items.

removeCacheUsageListener(CacheUsageListener) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

removeQuiet(Serializable) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Removes an Element from the Cache, without notifying listeners.

removeQuiet(Object) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Removes an Element from the Cache, without notifying listeners.

removeWithWriter(Object) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

S

setBootstrapCacheLoader(BootstrapCacheLoader) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Sets the bootstrap cache loader.

setCacheExceptionHandler(CacheExceptionHandler) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Sets an ExceptionHandler on the Cache.

setCacheManager(CacheManager) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Sets the CacheManager

setDisabled(boolean) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Disables or enables this cache.

setDiskStorePath(String) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

DiskStore paths can conflict between CacheManager instances.

setName(String) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Sets the cache name which will name.

setNodeCoherent(boolean) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

setSampledStatisticsEnabled(boolean) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

setStatisticsAccuracy(int) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Sets the statistics accuracy.

setStatisticsEnabled(boolean) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

setTransactionManagerLookup(TransactionManagerLookup) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

T

tryReadLockOnKey(Object, long) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Try to get a read lock on a given key.

tryWriteLockOnKey(Object, long) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Try to get a write lock on a given key.

U

unregisterCacheExtension(CacheExtension) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Unregister a CacheExtension with the cache.

unregisterCacheLoader(CacheLoader) - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

Unregister a CacheLoader with the cache.

unregisterCacheWriter() - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

W

waitUntilClusterCoherent() - Method in class net.sf.ehcache.constructs.locking.ExplicitLockingCache

A B C D E F G I L N P R S T U W