ehcache
A B C D E G H I L M N O P R S T U

A

addCache(String) - Method in class net.sf.ehcache.CacheManager
Use this to add a Cache.
addCache(Cache) - Method in class net.sf.ehcache.CacheManager
Use this to add a Cache.
addCache(Configuration.Cache) - Method in class net.sf.ehcache.config.Configuration
Allows BeanHandler to add disk caches to the configuration
addDefaultCache(Configuration.DefaultCache) - Method in class net.sf.ehcache.config.Configuration
Allows BeanHandler to add disk caches to the configuration
addDiskStore(Configuration.DiskStore) - Method in class net.sf.ehcache.config.Configuration
Allows BeanHandler to add disk store location to the configuration

B

BeanHandler - class net.sf.ehcache.config.BeanHandler.
A SAX handler that configures a bean.
BeanHandler(Object) - Constructor for class net.sf.ehcache.config.BeanHandler
Constructor
buildCache(String, Properties) - Method in class net.sf.ehcache.hibernate.Provider
Builds a Cache.

C

CACHE_HUB - Static variable in interface net.sf.ehcache.store.Store
Composite, including memory cache, type and central hub.
Cache - class net.sf.ehcache.Cache.
Cache is the central class in ehcache.
Cache(String, int, boolean, boolean, long, long) - Constructor for class net.sf.ehcache.Cache
Constructor.
Cache(String, int, boolean, boolean, long, long, boolean, long) - Constructor for class net.sf.ehcache.Cache
Full Constructor.
CacheException - exception net.sf.ehcache.CacheException.
A Cache Exception.
CacheException() - Constructor for class net.sf.ehcache.CacheException
Constructor for the CacheException object
CacheException(String) - Constructor for class net.sf.ehcache.CacheException
Constructor for the CacheException object
CacheException(String, Throwable) - Constructor for class net.sf.ehcache.CacheException
Constructor for the CachException object with a cause.
CacheManager - class net.sf.ehcache.CacheManager.
Manages all aspects of EHCache
Configuration - class net.sf.ehcache.config.Configuration.
The configuration for ehcache.
Configuration() - Constructor for class net.sf.ehcache.config.Configuration
 
Configuration.Cache - class net.sf.ehcache.config.Configuration.Cache.
A class to represent Cache configuration e.g.
Configuration.Cache() - Constructor for class net.sf.ehcache.config.Configuration.Cache
 
Configuration.DefaultCache - class net.sf.ehcache.config.Configuration.DefaultCache.
A class to represent the default cache e.g.
Configuration.DefaultCache() - Constructor for class net.sf.ehcache.config.Configuration.DefaultCache
 
Configuration.DiskStore - class net.sf.ehcache.config.Configuration.DiskStore.
A class to represent DiskStore configuration e.g.
Configuration.DiskStore() - Constructor for class net.sf.ehcache.config.Configuration.DiskStore
 
Configurator - class net.sf.ehcache.config.Configurator.
A utility class which configures beans from XML, using reflection.
Configurator() - Constructor for class net.sf.ehcache.config.Configurator
Constructor
cacheExists(String) - Method in class net.sf.ehcache.CacheManager
Checks whether a cache exists.
calculateDataFileSparseness() - Method in class net.sf.ehcache.store.DiskStore
The design of the layout on the data file means that there will be small gaps created when DiskElements are reused.
calculateInMemorySize() - Method in class net.sf.ehcache.Cache
Gets the size of the memory store for this cache

Warning: This method can be very expensive to run.

clear() - Method in class net.sf.ehcache.hibernate.Plugin
Remove all elements in the cache, but leave the cache in a useable state.
clone() - Method in class net.sf.ehcache.Cache
Clones a cache.
clone() - Method in class net.sf.ehcache.Element
Clones an Element.
configure(Object, File) - Method in class net.sf.ehcache.config.Configurator
Configures a bean from an XML file.
configure(Object, URL) - Method in class net.sf.ehcache.config.Configurator
Configures a bean from an XML file available as an URL.
configure(Object) - Method in class net.sf.ehcache.config.Configurator
Configures a bean from an XML file in the classpath.
configure(Object, InputStream) - Method in class net.sf.ehcache.config.Configurator
Configures a bean from an XML input stream
create() - Static method in class net.sf.ehcache.CacheManager
A factory method to create a CacheManager with default config.
create(String) - Static method in class net.sf.ehcache.CacheManager
A factory method to create a CacheManager with a specified configuration.
create(URL) - Static method in class net.sf.ehcache.CacheManager
A factory method to create a CacheManager from an URL.
create(InputStream) - Static method in class net.sf.ehcache.CacheManager
A factory method to create a CacheManager from a java.io.InputStream.

D

DEFAULT_CACHE_NAME - Static variable in class net.sf.ehcache.Cache
A reserved word for cache names.
DISK_CACHE - Static variable in interface net.sf.ehcache.store.Store
Disk cache type.
DiskStore - class net.sf.ehcache.store.DiskStore.
A disk cache implementation.
DiskStore(Cache, String) - Constructor for class net.sf.ehcache.store.DiskStore
Creates a disk store.
destroy() - Method in class net.sf.ehcache.hibernate.Plugin
Remove the cache and make it unuseable.
diskExpiryThreadIntervalSeconds - Variable in class net.sf.ehcache.config.Configuration.Cache
The interval in seconds between runs of the disk expiry thread.
diskPersistent - Variable in class net.sf.ehcache.config.Configuration.Cache
For caches that overflow to disk, does the disk cache persist between CacheManager instances?
dispose() - Method in class net.sf.ehcache.Cache
Flushes all cache items from memory to auxilliary caches and close the auxilliary caches.
dispose() - Method in class net.sf.ehcache.store.DiskStore
Shuts down the disk store in preparation for cache shutdown

If a VM crash happens, the shutdown hook will not run.

dispose() - Method in class net.sf.ehcache.store.MemoryStore
Prepares for shutdown.
dispose() - Method in interface net.sf.ehcache.store.Store
Prepares for shutdown.

E

Element - class net.sf.ehcache.Element.
A Cache Element, consisting of a key, value and attributes.
Element(Serializable, Serializable, long) - Constructor for class net.sf.ehcache.Element
A full constructor.
Element(Serializable, Serializable) - Constructor for class net.sf.ehcache.Element
Constructor
endElement(String, String, String) - Method in class net.sf.ehcache.config.BeanHandler
Receive notification of the end of an element.
eternal - Variable in class net.sf.ehcache.config.Configuration.Cache
Sets whether elements are eternal.

G

get(Serializable) - Method in class net.sf.ehcache.Cache
Gets an element from the cache.
get(Object) - Method in class net.sf.ehcache.hibernate.Plugin
Gets a value of an element which matches the given key.
get(Serializable) - Method in class net.sf.ehcache.store.DiskStore
Gets an Element from the Disk Store.
get(Serializable) - Method in class net.sf.ehcache.store.MemoryStore
Gets an item from the cache

The last access time in Element is updated.

get(Serializable) - Method in interface net.sf.ehcache.store.Store
Gets an item from the cache.
getCache(String) - Method in class net.sf.ehcache.CacheManager
Gets a Cache
getCache(String) - Method in class net.sf.ehcache.config.Configuration
Gets a cache
getCache() - Method in class net.sf.ehcache.store.MemoryStore
Gets the cache that the MemoryStore is used by
getCacheKeySet() - Method in class net.sf.ehcache.config.Configuration
Gets a Map of caches
getCacheNames() - Method in class net.sf.ehcache.CacheManager
Returns a list of the current cache names.
getCacheType() - Method in class net.sf.ehcache.store.DiskStore
Returns the store type.
getCacheType() - Method in class net.sf.ehcache.store.MemoryStore
Returns the cache type.
getCacheType() - Method in interface net.sf.ehcache.store.Store
Returns the cache type.
getConfiguration() - Method in class net.sf.ehcache.CacheManager
Returns configuration to classes in this package.
getCreationTime() - Method in class net.sf.ehcache.Element
Gets the creationTime attribute of the ElementAttributes object
getDataFileName() - Method in class net.sf.ehcache.store.DiskStore
 
getDataFilePath() - Method in class net.sf.ehcache.store.DiskStore
 
getDataFileSize() - Method in class net.sf.ehcache.store.DiskStore
 
getDefaultCache() - Method in class net.sf.ehcache.config.Configuration
 
getDiskCachePath() - Method in class net.sf.ehcache.config.Configuration
Gets the disk cache path
getDiskExpiryThreadIntervalSeconds() - Method in class net.sf.ehcache.Cache
 
getDiskStore() - Method in class net.sf.ehcache.Cache
Gets the internal DiskStore.
getDiskStoreHitCount() - Method in class net.sf.ehcache.Cache
Number of times a requested item was found in the Disk Store
getDiskStoreSize() - Method in class net.sf.ehcache.Cache
Returns the number of elements in the disk store.
getHitCount() - Method in class net.sf.ehcache.Cache
Number of times a requested item was found in the cache
getHitCount() - Method in class net.sf.ehcache.Element
Gets the hit count on this element.
getIndexFileName() - Method in class net.sf.ehcache.store.DiskStore
 
getIndexFileSize() - Method in class net.sf.ehcache.store.DiskStore
 
getInstance() - Static method in class net.sf.ehcache.CacheManager
A factory method to get an instance ofCacheManager.
getKey() - Method in class net.sf.ehcache.Element
Gets the key attribute of the Element object
getKeyArray() - Method in class net.sf.ehcache.store.DiskStore
Gets an Array of the keys for all elements in the disk store.
getKeyArray() - Method in class net.sf.ehcache.store.MemoryStore
Gets an Array of the keys for all elements in the memory cache

Does not check for expired entries

getKeys() - Method in class net.sf.ehcache.Cache
Returns a list of all elements in the cache, whether or not they are expired.
getKeysNoDuplicateCheck() - Method in class net.sf.ehcache.Cache
Returns a list of all elements in the cache, whether or not they are expired.
getKeysWithExpiryCheck() - Method in class net.sf.ehcache.Cache
Returns a list of all elements in the cache.
getLastAccessTime() - Method in class net.sf.ehcache.Element
Gets the last access time.
getMaxElementsInMemory() - Method in class net.sf.ehcache.Cache
Gets the maximum number of elements to hold in memory
getMemoryStore() - Method in class net.sf.ehcache.Cache
Gets the internal MemoryStore.
getMemoryStoreHitCount() - Method in class net.sf.ehcache.Cache
Number of times a requested item was found in the Memory Store
getMemoryStoreSize() - Method in class net.sf.ehcache.Cache
Returns the number of elements in the memory store.
getMissCountExpired() - Method in class net.sf.ehcache.Cache
Number of times a requested element was found but was expired
getMissCountNotFound() - Method in class net.sf.ehcache.Cache
Number of times a requested element was not found in the cache.
getName() - Method in class net.sf.ehcache.Cache
Gets the cache name
getName() - Method in class net.sf.ehcache.store.DiskStore
Returns the cache name this disk cache is spooling for
getName() - Method in class net.sf.ehcache.store.MemoryStore
Returns the cache name.
getName() - Method in interface net.sf.ehcache.store.Store
Returns the cache name.
getNextToLastAccessTime() - Method in class net.sf.ehcache.Element
Gets the next to last access time.
getQuiet(Serializable) - Method in class net.sf.ehcache.Cache
Gets an element from the cache, without updating Element statistics.
getQuiet(Serializable) - Method in class net.sf.ehcache.store.DiskStore
Gets an Element from the Disk Store, without updating statistics
getQuiet(Serializable) - Method in class net.sf.ehcache.store.MemoryStore
Gets an item from the cache, without updating Element statistics

The last access time in Element is updated.

getSerializedSize() - Method in class net.sf.ehcache.Element
The size of this object in serialized form.
getSize() - Method in class net.sf.ehcache.Cache
Gets the size of the cache.
getSize() - Method in class net.sf.ehcache.store.DiskStore
Returns the current store size.
getSize() - Method in class net.sf.ehcache.store.MemoryStore
Returns the current cache size.
getSize() - Method in interface net.sf.ehcache.store.Store
Returns the current cache size.
getSizeInBytes() - Method in class net.sf.ehcache.store.MemoryStore
Measures the size of the memory store by measuring the serialized size of all elements.
getStatus() - Method in class net.sf.ehcache.Cache
Gets the status attribute of the Store object
getStatus() - Method in class net.sf.ehcache.CacheManager
Gets the status of the CacheManager.
getStatus() - Method in class net.sf.ehcache.store.DiskStore
Returns the cache status.
getStatus() - Method in class net.sf.ehcache.store.MemoryStore
Gets the status of the MemoryStore.
getStatus() - Method in interface net.sf.ehcache.store.Store
Returns the cache status.
getTimeToIdleSeconds() - Method in class net.sf.ehcache.Cache
Gets timeToIdleSeconds
getTimeToLiveSeconds() - Method in class net.sf.ehcache.Cache
Gets timeToLiveSeconds
getTimeout() - Method in class net.sf.ehcache.hibernate.Plugin
Returns the lock timeout for this cache.
getTotalFileSize() - Method in class net.sf.ehcache.store.DiskStore
 
getUsedDataSize() - Method in class net.sf.ehcache.store.DiskStore
When elements are deleted, spaces are left in the file.
getValue() - Method in class net.sf.ehcache.Element
Gets the value attribute of the Element object
getVersion() - Method in class net.sf.ehcache.Element
Gets the version attribute of the ElementAttributes object

H

hashCode() - Method in class net.sf.ehcache.Element
Description of the Method

I

initialise(Configuration) - Method in class net.sf.ehcache.Cache
Newly created caches do not have a MemoryStore or a DiskStore.
isDiskPersistent() - Method in class net.sf.ehcache.Cache
 
isEternal() - Method in class net.sf.ehcache.Cache
Are elements eternal
isExpired(Element) - Method in class net.sf.ehcache.Cache
Checks whether this cache element has expired.
isExpiryThreadAlive() - Method in class net.sf.ehcache.store.DiskStore
The expiry thread is started provided the cache is not eternal

If started it will continue to run until the dispose() method is called, at which time it should be interrupted and then die.

isOverflowToDisk() - Method in class net.sf.ehcache.Cache
Does the overflow go to disk
isSpoolEmpty() - Method in class net.sf.ehcache.store.DiskStore
Whether there are any elements waiting to be spooled to disk.

L

loadMapInstance() - Method in class net.sf.ehcache.store.MemoryStore
Tries to load a LinkedHashMap (JDK1.4) and then tries to load an LRUMap.
lock(Object) - Method in class net.sf.ehcache.hibernate.Plugin
Calls to this method should perform there own synchronization.

M

MemoryStore - class net.sf.ehcache.store.MemoryStore.
An implementation of a MemoryStore.
MemoryStore(Cache, DiskStore) - Constructor for class net.sf.ehcache.store.MemoryStore
Constructor for the MemoryStore object The backing LinkedHashMap is created with LRU by access order.
MemoryStore.SpoolingLRUMap - class net.sf.ehcache.store.MemoryStore.SpoolingLRUMap.
An LRU Map implementation based on Apache Commons LRUMap.
MemoryStore.SpoolingLRUMap() - Constructor for class net.sf.ehcache.store.MemoryStore.SpoolingLRUMap
Constructor.
MemoryStore.SpoolingLinkedHashMap - class net.sf.ehcache.store.MemoryStore.SpoolingLinkedHashMap.
An extension of LinkedHashMap which overrides MemoryStore.SpoolingLinkedHashMap.removeEldestEntry(java.util.Map.Entry) to persist cache entries to the auxiliary cache before they are removed.
MemoryStore.SpoolingLinkedHashMap() - Constructor for class net.sf.ehcache.store.MemoryStore.SpoolingLinkedHashMap
Default constructor.
maxElementsInMemory - Variable in class net.sf.ehcache.config.Configuration.Cache
the maximum objects to be held in memory

N

name - Variable in class net.sf.ehcache.config.Configuration.Cache
the name of the cache
net.sf.ehcache - package net.sf.ehcache
This package contains the public API for using ehcache.
net.sf.ehcache.config - package net.sf.ehcache.config
This package contains the cache configuration code.
net.sf.ehcache.hibernate - package net.sf.ehcache.hibernate
This package provides integration with the Hibernate Object Relational tool.
net.sf.ehcache.store - package net.sf.ehcache.store
Store package.
nextTimestamp() - Method in class net.sf.ehcache.hibernate.Plugin
Gets the next timestamp;
nextTimestamp() - Method in class net.sf.ehcache.hibernate.Provider
Returns the next timestamp.

O

ObjectExistsException - exception net.sf.ehcache.ObjectExistsException.
Thrown when a duplicate cache is attemtpted to be created
ObjectExistsException() - Constructor for class net.sf.ehcache.ObjectExistsException
Constructor for the ObjectExistsException object
ObjectExistsException(String) - Constructor for class net.sf.ehcache.ObjectExistsException
Constructor for the ObjectExistsException object
overflowToDisk - Variable in class net.sf.ehcache.config.Configuration.Cache
whether elements can overflow to disk when the in-memory cache has reached the set limit.

P

Plugin - class net.sf.ehcache.hibernate.Plugin.
EHCache plugin for Hibernate EHCache uses a MemoryStore and a DiskStore.
Plugin(String) - Constructor for class net.sf.ehcache.hibernate.Plugin
Creates a new Hibernate pluggable cache based on a cache name.
Provider - class net.sf.ehcache.hibernate.Provider.
Cache Provider plugin for Hibernate Use hibernate.cache.provider_class=net.sf.ehcache.hibernate.Provider in Hibernate 2.1 or later.
Provider() - Constructor for class net.sf.ehcache.hibernate.Provider
 
processRemovedLRU(Object, Object) - Method in class net.sf.ehcache.store.MemoryStore.SpoolingLRUMap
Called after the element has been removed.
put(Element) - Method in class net.sf.ehcache.Cache
Put an element in the cache.
put(Object, Object) - Method in class net.sf.ehcache.hibernate.Plugin
Puts an object into the cache.
put(Element) - Method in class net.sf.ehcache.store.DiskStore
Puts an item into the cache.
put(Element) - Method in class net.sf.ehcache.store.MemoryStore
Puts an item in the cache.
put(Element) - Method in interface net.sf.ehcache.store.Store
Puts an item into the cache.
putQuiet(Element) - Method in class net.sf.ehcache.Cache
Put an element in the cache, without updating statistics.

R

remove(Serializable) - Method in class net.sf.ehcache.Cache
Removes an Element from the Cache.
remove(Object) - Method in class net.sf.ehcache.hibernate.Plugin
Removes the element which matches the key.
remove(Serializable) - Method in class net.sf.ehcache.store.DiskStore
Removes an item from the cache.
remove(Serializable) - Method in class net.sf.ehcache.store.MemoryStore
Removes an item from the cache.
remove(Serializable) - Method in interface net.sf.ehcache.store.Store
Removes an item from the cache.
removeAll() - Method in class net.sf.ehcache.Cache
Removes all cached items.
removeAll() - Method in class net.sf.ehcache.store.DiskStore
Removes all cached items from the cache.
removeAll() - Method in class net.sf.ehcache.store.MemoryStore
Remove all of the elements from the cache.
removeAll() - Method in interface net.sf.ehcache.store.Store
Removes all cached items from the cache.
removeCache(String) - Method in class net.sf.ehcache.CacheManager
Remove a cache from the CacheManager
removeEldestEntry(Map.Entry) - Method in class net.sf.ehcache.store.MemoryStore.SpoolingLinkedHashMap
Returns true if this map should remove its eldest entry.
resetAccessStatistics() - Method in class net.sf.ehcache.Element
Resets the hit count to 0 and the last access time to 0

S

STATUS_ALIVE - Static variable in class net.sf.ehcache.Cache
The cache is alive.
STATUS_ALIVE - Static variable in class net.sf.ehcache.CacheManager
Store alive status.
STATUS_ALIVE - Static variable in interface net.sf.ehcache.store.Store
Store alive status.
STATUS_DISPOSED - Static variable in class net.sf.ehcache.Cache
The cache is uninitialised.
STATUS_DISPOSED - Static variable in interface net.sf.ehcache.store.Store
Store disposed status.
STATUS_ERROR - Static variable in interface net.sf.ehcache.store.Store
Store in error.
STATUS_SHUTDOWN - Static variable in class net.sf.ehcache.CacheManager
Store disposed status.
STATUS_UNINITIALISED - Static variable in class net.sf.ehcache.Cache
The cache is uninitialised.
STATUS_UNINITIALISED - Static variable in class net.sf.ehcache.CacheManager
Store alive status.
STATUS_UNINITIALISED - Static variable in interface net.sf.ehcache.store.Store
Store alive status.
Store - interface net.sf.ehcache.store.Store.
This is the interface for all stores.
serialVersionUID - Static variable in class net.sf.ehcache.Element
serial version
setCreateTime() - Method in class net.sf.ehcache.Element
Sets the creationTime attribute of the ElementAttributes object
setDiskExpiryThreadIntervalSeconds(int) - Method in class net.sf.ehcache.config.Configuration.Cache
Sets the interval in seconds between runs of the disk expiry thread.
setDiskPersistent(boolean) - Method in class net.sf.ehcache.config.Configuration.Cache
Sets whether, for caches that overflow to disk, the disk cache persist between CacheManager instances
setDocumentLocator(Locator) - Method in class net.sf.ehcache.config.BeanHandler
Receive a Locator object for document events.
setEternal(boolean) - Method in class net.sf.ehcache.config.Configuration.Cache
Sets whether elements are eternal.
setMaxElementsInMemory(int) - Method in class net.sf.ehcache.config.Configuration.Cache
Sets the maximum objects to be held in memory
setName(String) - Method in class net.sf.ehcache.Cache
Sets the name
setName(String) - Method in class net.sf.ehcache.config.Configuration.Cache
Sets the name of the cache.
setOverflowToDisk(boolean) - Method in class net.sf.ehcache.config.Configuration.Cache
Sets whether elements can overflow to disk when the in-memory cache has reached the set limit.
setPath(String) - Method in class net.sf.ehcache.config.Configuration.DiskStore
Sets the path
setTimeToIdleSeconds(int) - Method in class net.sf.ehcache.config.Configuration.Cache
Sets the time to idle for an element before it expires.
setTimeToLiveSeconds(int) - Method in class net.sf.ehcache.config.Configuration.Cache
Sets the time to idle for an element before it expires.
setVersion(long) - Method in class net.sf.ehcache.Element
Sets the version attribute of the ElementAttributes object
shutdown() - Method in class net.sf.ehcache.CacheManager
Each call to CacheManager.create() must ultimately be matched by a call to this method.
startElement(String, String, String, Attributes) - Method in class net.sf.ehcache.config.BeanHandler
Receive notification of the start of an element.

T

timeToIdleSeconds - Variable in class net.sf.ehcache.config.Configuration.Cache
the time to idle for an element before it expires.
timeToLiveSeconds - Variable in class net.sf.ehcache.config.Configuration.Cache
Sets the time to idle for an element before it expires.
toString() - Method in class net.sf.ehcache.Cache
Returns a String representation of Cache
toString() - Method in class net.sf.ehcache.Element
Returns a String representation of the Element
toString() - Method in class net.sf.ehcache.store.DiskStore
Returns a String representation of the DiskStore

U

unlock(Object) - Method in class net.sf.ehcache.hibernate.Plugin
Calls to this method should perform there own synchronization.
updateAccessStatistics() - Method in class net.sf.ehcache.Element
Sets the last access time to now.

A B C D E G H I L M N O P R S T U
ehcache