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 locationb 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

Full Constructor.

CacheException - exception net.sf.ehcache.CacheException.

This Exception does not use the new JDK1.4 chainable excecptions facility to maintain backward compatibility with JDK1.2 and JDK1.3.

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

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.

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.

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.

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.

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 with defaults.

DiskStore(Cache, String, int) - Constructor for class net.sf.ehcache.store.DiskStore

Creates a cache.

destroy() - Method in class net.sf.ehcache.hibernate.Plugin

Remove the cache and make it unuseable.

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

Prepares for shutdown.

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(String) - Static method in class net.sf.ehcache.store.DiskStore

Locates a cache, by name.

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 cache 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

getDefaultCache() - Method in class net.sf.ehcache.config.Configuration

Gets the Default Cache

getDiskCachePath() - Method in class net.sf.ehcache.config.Configuration

Gets the disk cache path

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.

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 memory cache

getKeyArray() - Method in class net.sf.ehcache.store.MemoryStore

Gets an Array of the keys for all elements in the memory cache

getKeys() - Method in class net.sf.ehcache.Cache

Returns the keys of all elements in the cache The List returned is not live.

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.

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.

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.

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.

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.

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 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.

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 to 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.

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.

setCreateTime() - Method in class net.sf.ehcache.Element

Sets the creationTime attribute of the ElementAttributes object

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 previous to last access time to the last access time, and the last access time to now.

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