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

A

AbstractPolicy - Class in net.sf.ehcache.store
A base policy class
AbstractPolicy() - Constructor for class net.sf.ehcache.store.AbstractPolicy
 
acquire() - Method in class net.sf.ehcache.concurrent.Mutex
Wait (possibly forever) until successful passage.
acquire() - Method in interface net.sf.ehcache.concurrent.Sync
Wait (possibly forever) until successful passage.
acquireCachePeers(Ehcache) - Method in class net.sf.ehcache.distribution.RMIBootstrapCacheLoader
Acquires the cache peers for this cache.
addBootstrapCacheLoaderFactory(CacheConfiguration.BootstrapCacheLoaderFactoryConfiguration) - Method in class net.sf.ehcache.config.CacheConfiguration
Allows BeanHandler to add the CacheManagerEventListener to the configuration.
addCache(String) - Method in class net.sf.ehcache.CacheManager
Adds a Ehcache based on the defaultCache with the given name.
addCache(Cache) - Method in class net.sf.ehcache.CacheManager
Adds a Cache to the CacheManager.
addCache(Ehcache) - Method in class net.sf.ehcache.CacheManager
Adds an Ehcache to the CacheManager.
addCache(CacheConfiguration) - Method in class net.sf.ehcache.config.Configuration
Allows BeanHandler to add Cache Configurations to the configuration.
addCacheEventListenerFactory(CacheConfiguration.CacheEventListenerFactoryConfiguration) - Method in class net.sf.ehcache.config.CacheConfiguration
Used by BeanUtils to add cacheEventListenerFactory elements to the cache configuration.
addCacheExceptionHandlerFactory(CacheConfiguration.CacheExceptionHandlerFactoryConfiguration) - Method in class net.sf.ehcache.config.CacheConfiguration
Allows BeanHandler to add the CacheExceptionHandlerFactory to the configuration.
addCacheExtensionFactory(CacheConfiguration.CacheExtensionFactoryConfiguration) - Method in class net.sf.ehcache.config.CacheConfiguration
Used by BeanUtils to add cacheExtensionFactory elements to the cache configuration.
addCacheLoaderFactory(CacheConfiguration.CacheLoaderFactoryConfiguration) - Method in class net.sf.ehcache.config.CacheConfiguration
Used by BeanUtils to add each cacheLoaderFactory to the cache configuration.
addCacheManagerEventListenerFactory(FactoryConfiguration) - Method in class net.sf.ehcache.config.Configuration
Allows BeanHandler to add the CacheManagerEventListener to the configuration.
addCacheManagerPeerListenerFactory(FactoryConfiguration) - Method in class net.sf.ehcache.config.Configuration
Adds a CachePeerProviderFactoryConfiguration.
addCacheManagerPeerProviderFactory(FactoryConfiguration) - Method in class net.sf.ehcache.config.Configuration
Adds a CachePeerProviderFactoryConfiguration.
addDefaultCache(CacheConfiguration) - Method in class net.sf.ehcache.config.Configuration
Allows BeanHandler to add a default configuration to the configuration.
addDiskStore(DiskStoreConfiguration) - Method in class net.sf.ehcache.config.Configuration
Allows BeanHandler to add disk store location to the configuration.
addToReplicationQueue(RMIAsynchronousCacheReplicator.CacheEventMessage) - Method in class net.sf.ehcache.distribution.RMIAsynchronousCacheReplicator
Adds a message to the queue.
alive() - Method in interface net.sf.ehcache.distribution.CacheReplicator
Checks that the replicator is is STATUS_ALIVE.
alive() - Method in class net.sf.ehcache.distribution.RMISynchronousCacheReplicator
Checks that the replicator is is STATUS_ALIVE.
ALL_CACHE_MANAGERS - Static variable in class net.sf.ehcache.CacheManager
Keeps track of all known CacheManagers.
assignFreePort(boolean) - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerListener
Assigns a free port to be the listener port.
asynchronous - Variable in class net.sf.ehcache.distribution.RMIBootstrapCacheLoader
Whether to load asynchronously
AsynchronousCommandException - Exception in net.sf.ehcache.constructs.asynchronous
Thrown when an asynchronous command has somehow failed.
AsynchronousCommandException(String) - Constructor for exception net.sf.ehcache.constructs.asynchronous.AsynchronousCommandException
Constructs a new exception with the specified detail message.
AsynchronousCommandException(String, Throwable) - Constructor for exception net.sf.ehcache.constructs.asynchronous.AsynchronousCommandException
Constructs a new exception with the specified detail message and cause.
AsynchronousCommandExecutor - Class in net.sf.ehcache.constructs.asynchronous
Handles the asynchronous execution of commands.
asynchronousReplicationInterval - Variable in class net.sf.ehcache.distribution.RMIAsynchronousCacheReplicator
The amount of time the replication thread sleeps after it detects the replicationQueue is empty before checking again.
attempt(long) - Method in class net.sf.ehcache.concurrent.Mutex
 
attempt(long) - Method in interface net.sf.ehcache.concurrent.Sync
Wait at most msecs to pass; report whether passed.
attemptResolutionOfUniqueResourceConflict() - Method in interface net.sf.ehcache.distribution.CacheManagerPeerListener
If a conflict is detected in unique resource use, this method signals the listener to attempt automatic resolution of the resource conflict.
attemptResolutionOfUniqueResourceConflict() - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerListener
If a conflict is detected in unique resource use, this method signals the listener to attempt automatic resolution of the resource conflict.
AUTO_DISK_PATH_DIRECTORY_PREFIX - Static variable in class net.sf.ehcache.store.DiskStore
If the CacheManager needs to resolve a conflict with the disk path, it will create a subdirectory in the given disk path with this prefix followed by a number.

B

bind(String, RMICachePeer) - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerListener
Bind a cache peer
BlockingCache - Class in net.sf.ehcache.constructs.blocking
A blocking decorator for an Ehcache, backed by a Ehcache.
BlockingCache(Ehcache) - Constructor for class net.sf.ehcache.constructs.blocking.BlockingCache
Creates a BlockingCache which decorates the supplied cache.
bootstrap() - Method in class net.sf.ehcache.Cache
Bootstrap command.
bootstrap() - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Bootstrap command.
bootstrap() - Method in interface net.sf.ehcache.Ehcache
Bootstrap command.
BOOTSTRAP_ASYNCHRONOUSLY - Static variable in class net.sf.ehcache.distribution.RMIBootstrapCacheLoaderFactory
The property name expected in ehcache.xml for the bootstrap asyncrhonously switch.
BootstrapCacheLoader - Interface in net.sf.ehcache.bootstrap
 
BootstrapCacheLoaderFactory - Class in net.sf.ehcache.bootstrap
An abstract factory for creating BootstrapCacheLoader instances.
BootstrapCacheLoaderFactory() - Constructor for class net.sf.ehcache.bootstrap.BootstrapCacheLoaderFactory
 
bootstrapCacheLoaderFactoryConfiguration - Variable in class net.sf.ehcache.config.CacheConfiguration
The BootstrapCacheLoaderFactoryConfiguration.
bufferFull() - Method in class net.sf.ehcache.store.DiskStore
In some circumstances data can be written so quickly to the spool that the VM runs out of memory while waiting for the spooling to disk.
bufferFull() - Method in class net.sf.ehcache.store.LruMemoryStore
Memory stores are never backed up and always return false
bufferFull() - Method in class net.sf.ehcache.store.MemoryStore
Memory stores are never backed up and always return false
bufferFull() - Method in interface net.sf.ehcache.store.Store
Some store types, such as the disk stores can fill their write buffers if puts come in too fast.
buildCache(String, Properties) - Method in class net.sf.ehcache.hibernate.EhCacheProvider
Builds a Cache.
buildCache(String, Properties) - Method in class net.sf.ehcache.hibernate.SingletonEhCacheProvider
Builds a Cache.

C

Cache - Class in net.sf.ehcache
Cache is the central class in ehcache.
Cache(String, int, boolean, boolean, long, long) - Constructor for class net.sf.ehcache.Cache
1.0 Constructor.
Cache(String, int, boolean, boolean, long, long, boolean, long) - Constructor for class net.sf.ehcache.Cache
1.1 Constructor.
Cache(String, int, MemoryStoreEvictionPolicy, boolean, String, boolean, long, long, boolean, long, RegisteredEventListeners) - Constructor for class net.sf.ehcache.Cache
1.2 Constructor

The ConfigurationFactory and clients can create these.

Cache(String, int, MemoryStoreEvictionPolicy, boolean, String, boolean, long, long, boolean, long, RegisteredEventListeners, BootstrapCacheLoader) - Constructor for class net.sf.ehcache.Cache
1.2.1 Constructor

The ConfigurationFactory and clients can create these.

Cache(String, int, MemoryStoreEvictionPolicy, boolean, String, boolean, long, long, boolean, long, RegisteredEventListeners, BootstrapCacheLoader, int) - Constructor for class net.sf.ehcache.Cache
1.2.4 Constructor

The ConfigurationFactory and clients can create these.

Cache(String, int, MemoryStoreEvictionPolicy, boolean, String, boolean, long, long, boolean, long, RegisteredEventListeners, BootstrapCacheLoader, int, int) - Constructor for class net.sf.ehcache.Cache
1.3 Constructor

The ConfigurationFactory and clients can create these.

Cache(String, int, MemoryStoreEvictionPolicy, boolean, String, boolean, long, long, boolean, long, RegisteredEventListeners, BootstrapCacheLoader, int, int, boolean) - Constructor for class net.sf.ehcache.Cache
1.6.0 Constructor

The ConfigurationFactory and clients can create these.

cache - Variable in class net.sf.ehcache.constructs.blocking.BlockingCache
The backing Cache
Cache - Class in net.sf.ehcache.management
A JMX MBean implementation for Cache
Cache(Ehcache) - Constructor for class net.sf.ehcache.management.Cache
A constructor for JCache.
cache - Variable in class net.sf.ehcache.store.LruMemoryStore
The cache this store is associated with.
cache - Variable in class net.sf.ehcache.store.MemoryStore
The cache this store is associated with.
CacheConfiguration - Class in net.sf.ehcache.config
A value object to represent Cache configuration that can be set by the BeanHandler.
CacheConfiguration() - Constructor for class net.sf.ehcache.config.CacheConfiguration
 
CacheConfiguration - Class in net.sf.ehcache.management
A JMX MBean implementation and decorator to net.sf.ehcache.CacheConfiguration
CacheConfiguration(Ehcache) - Constructor for class net.sf.ehcache.management.CacheConfiguration
Constructs using a backing CacheConfiguration
CacheConfiguration.BootstrapCacheLoaderFactoryConfiguration - Class in net.sf.ehcache.config
Configuration for the BootstrapCacheLoaderFactoryConfiguration.
CacheConfiguration.BootstrapCacheLoaderFactoryConfiguration() - Constructor for class net.sf.ehcache.config.CacheConfiguration.BootstrapCacheLoaderFactoryConfiguration
 
CacheConfiguration.CacheEventListenerFactoryConfiguration - Class in net.sf.ehcache.config
Configuration for the CachePeerListenerFactoryConfiguration.
CacheConfiguration.CacheEventListenerFactoryConfiguration() - Constructor for class net.sf.ehcache.config.CacheConfiguration.CacheEventListenerFactoryConfiguration
 
CacheConfiguration.CacheExceptionHandlerFactoryConfiguration - Class in net.sf.ehcache.config
Configuration for the BootstrapCacheLoaderFactoryConfiguration.
CacheConfiguration.CacheExceptionHandlerFactoryConfiguration() - Constructor for class net.sf.ehcache.config.CacheConfiguration.CacheExceptionHandlerFactoryConfiguration
 
CacheConfiguration.CacheExtensionFactoryConfiguration - Class in net.sf.ehcache.config
Configuration for the CacheExtensionFactoryConfiguration.
CacheConfiguration.CacheExtensionFactoryConfiguration() - Constructor for class net.sf.ehcache.config.CacheConfiguration.CacheExtensionFactoryConfiguration
 
CacheConfiguration.CacheLoaderFactoryConfiguration - Class in net.sf.ehcache.config
Configuration for the CacheLoaderFactoryConfiguration.
CacheConfiguration.CacheLoaderFactoryConfiguration() - Constructor for class net.sf.ehcache.config.CacheConfiguration.CacheLoaderFactoryConfiguration
 
CacheConfigurationMBean - Interface in net.sf.ehcache.management
A JMX MBean interface for the configuration of a cache
CacheEntryFactory - Interface in net.sf.ehcache.constructs.blocking
Creates objects to populate the cache.
CacheEventListener - Interface in net.sf.ehcache.event
Allows implementers to register callback methods that will be executed when a cache event occurs.
cacheEventListenerConfigurations - Variable in class net.sf.ehcache.config.CacheConfiguration
The event listener factories added by BeanUtils.
CacheEventListenerFactory - Class in net.sf.ehcache.event
An abstract factory for creating listeners.
CacheEventListenerFactory() - Constructor for class net.sf.ehcache.event.CacheEventListenerFactory
 
CacheException - Exception in net.sf.ehcache
A runtime Cache Exception.
CacheException() - Constructor for exception net.sf.ehcache.CacheException
Constructor for the CacheException object.
CacheException(String) - Constructor for exception net.sf.ehcache.CacheException
Constructor for the CacheException object.
CacheException(String, Throwable) - Constructor for exception net.sf.ehcache.CacheException
Constructs a new CacheException with the specified detail message and cause.
CacheException(Throwable) - Constructor for exception net.sf.ehcache.CacheException
Constructs a new CacheException with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).
CacheExceptionHandler - Interface in net.sf.ehcache.exceptionhandler
A handler which may be registered with an Ehcache, to handle exceptions on Cache operations.
CacheExceptionHandlerFactory - Class in net.sf.ehcache.exceptionhandler
An abstract factory for creating CacheExceptionHandlers at configuration time, in ehcache.xml.
CacheExceptionHandlerFactory() - Constructor for class net.sf.ehcache.exceptionhandler.CacheExceptionHandlerFactory
 
cacheExceptionHandlerFactoryConfiguration - Variable in class net.sf.ehcache.config.CacheConfiguration
The CacheExceptionHandlerFactoryConfiguration.
cacheExists(String) - Method in class net.sf.ehcache.CacheManager
Checks whether a cache of type ehcache exists.
CacheExtension - Interface in net.sf.ehcache.extension
This is a general purpose mechanism to allow generic extensions to a Cache.
cacheExtensionConfigurations - Variable in class net.sf.ehcache.config.CacheConfiguration
The cache extension factories added by BeanUtils.
CacheExtensionFactory - Class in net.sf.ehcache.extension
An abstract factory for creating CacheExtensions.
CacheExtensionFactory() - Constructor for class net.sf.ehcache.extension.CacheExtensionFactory
 
CacheLoader - Interface in net.sf.ehcache.loader
Extends JCache CacheLoader with load methods that take an argument in addition to a key This interface has exactly the same interface as in the JCache module.
cacheLoaderConfigurations - Variable in class net.sf.ehcache.config.CacheConfiguration
The cache loader factories added by BeanUtils.
CacheLoaderFactory - Class in net.sf.ehcache.loader
An abstract factory for creating cache loaders.
CacheLoaderFactory() - Constructor for class net.sf.ehcache.loader.CacheLoaderFactory
 
CacheManager - Class in net.sf.ehcache
A container for Ehcaches that maintain all aspects of their lifecycle.
CacheManager(Configuration) - Constructor for class net.sf.ehcache.CacheManager
An constructor for CacheManager, which takes a configuration object, rather than one created by parsing an ehcache.xml file.
CacheManager(String) - Constructor for class net.sf.ehcache.CacheManager
An ordinary constructor for CacheManager.
CacheManager(URL) - Constructor for class net.sf.ehcache.CacheManager
An ordinary constructor for CacheManager.
CacheManager(InputStream) - Constructor for class net.sf.ehcache.CacheManager
An ordinary constructor for CacheManager.
CacheManager() - Constructor for class net.sf.ehcache.CacheManager
Constructor.
cacheManager - Variable in class net.sf.ehcache.distribution.RMICacheManagerPeerProvider
The CacheManager this peer provider is associated with.
CacheManager - Class in net.sf.ehcache.management
An MBean implementation for those attributes and operations we wish to expose on net.sf.ehcache.CacheManager.
CacheManager(CacheManager) - Constructor for class net.sf.ehcache.management.CacheManager
Create a management CacheManager
CacheManagerEventListener - Interface in net.sf.ehcache.event
Allows implementers to register callback methods that will be executed when a CacheManager event occurs.
CacheManagerEventListenerFactory - Class in net.sf.ehcache.event
An abstract factory for creating CacheManagerEventListeners.
CacheManagerEventListenerFactory() - Constructor for class net.sf.ehcache.event.CacheManagerEventListenerFactory
 
cacheManagerEventListenerRegistry - Variable in class net.sf.ehcache.CacheManager
The listener registry
CacheManagerEventListenerRegistry - Class in net.sf.ehcache.event
Registered listeners for registering and unregistering CacheManagerEventListeners and sending notifications to registrants.
CacheManagerEventListenerRegistry() - Constructor for class net.sf.ehcache.event.CacheManagerEventListenerRegistry
Construct a new registry
CacheManagerMBean - Interface in net.sf.ehcache.management
An MBean interface for those attributes and operations we wish to expose on net.sf.ehcache.CacheManager
CacheManagerPeerListener - Interface in net.sf.ehcache.distribution
A listener for updates, which controls remote cache peers.
CacheManagerPeerListenerFactory - Class in net.sf.ehcache.distribution
An abstract factory for creating cache manager peer listeners.
CacheManagerPeerListenerFactory() - Constructor for class net.sf.ehcache.distribution.CacheManagerPeerListenerFactory
 
cacheManagerPeerListeners - Variable in class net.sf.ehcache.CacheManager
The map of listeners
CacheManagerPeerProvider - Interface in net.sf.ehcache.distribution
Provides a discovery service to locate CachePeer RMI listener peers for a Cache.
CacheManagerPeerProviderFactory - Class in net.sf.ehcache.distribution
An abstract factory for creating peers.
CacheManagerPeerProviderFactory() - Constructor for class net.sf.ehcache.distribution.CacheManagerPeerProviderFactory
 
cacheManagerPeerProviders - Variable in class net.sf.ehcache.CacheManager
The map of providers
CacheMBean - Interface in net.sf.ehcache.management
A management bean for a cache
CachePeer - Interface in net.sf.ehcache.distribution
An interface for a cache peer to which updates are made remotely.
cachePeers - Variable in class net.sf.ehcache.distribution.RMICacheManagerPeerListener
The cache peers.
CacheReplicator - Interface in net.sf.ehcache.distribution
Replicates cache entries to peers of the CacheManager
caches - Variable in class net.sf.ehcache.CacheManager
Caches managed by this manager.
CacheStatistics - Class in net.sf.ehcache.management
A JMX CacheStatistics decorator for an ehcache Statistics class.
CacheStatistics(Ehcache) - Constructor for class net.sf.ehcache.management.CacheStatistics
Constructs an object from an ehcache statistics object
CacheStatisticsMBean - Interface in net.sf.ehcache.management
 
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.
calculateHostAddress() - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerListener
Calculates the host address as the default NICs IP address
calculateInMemorySize() - Method in class net.sf.ehcache.Cache
Gets the size of the memory store for this cache.
calculateInMemorySize() - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Gets the size of the memory store for this cache

Warning: This method can be very expensive to run.

calculateInMemorySize() - Method in interface net.sf.ehcache.Ehcache
Gets the size of the memory store for this cache

Warning: This method can be very expensive to run.

checkStatus() - Method in class net.sf.ehcache.CacheManager
Checks the state of the CacheManager for legal operation
ClassLoaderUtil - Class in net.sf.ehcache.util
Keeps all classloading in ehcache consistent.
clear() - Method in class net.sf.ehcache.hibernate.EhCache
Remove all elements in the cache, but leave the cache in a useable state.
clear() - Method in class net.sf.ehcache.store.LruMemoryStore
Clears any data structures and places it back to its state when it was first created.
clear() - Method in class net.sf.ehcache.store.MemoryStore
Clears any data structures and places it back to its state when it was first created.
clearAll() - Method in class net.sf.ehcache.CacheManager
Clears the contents of all caches in the CacheManager, but without removing any caches.
clearAll() - Method in class net.sf.ehcache.management.CacheManager
Clears the contents of all caches in the CacheManager, but without removing any caches.
clearAll() - Method in interface net.sf.ehcache.management.CacheManagerMBean
Clears the contents of all caches in the CacheManager, but without removing any caches.
clearCounters() - Method in class net.sf.ehcache.event.RegisteredEventListeners
Clears all event counters
clearOnFlush - Variable in class net.sf.ehcache.config.CacheConfiguration
Sets whether the MemoryStore should be cleared when flush() is called on the cache - true by default.
clearStatistics() - Method in class net.sf.ehcache.Cache
Resets statistics counters back to 0.
clearStatistics() - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Resets statistics counters back to 0.
clearStatistics() - Method in interface net.sf.ehcache.Ehcache
Resets statistics counters back to 0.
clearStatistics() - Method in class net.sf.ehcache.management.CacheStatistics
Clears the statistic counters to 0 for the associated Cache.
clearStatistics() - Method in interface net.sf.ehcache.management.CacheStatisticsMBean
Clears the statistic counters to 0 for the associated Cache.
clearStatistics() - Method in class net.sf.ehcache.Statistics
Clears the statistic counters to 0 for the associated Cache.
clone() - Method in interface net.sf.ehcache.bootstrap.BootstrapCacheLoader
Clones the loader
clone() - Method in class net.sf.ehcache.Cache
Clones a cache.
clone() - Method in class net.sf.ehcache.config.CacheConfiguration
Clones this object, following the usual contract.
clone() - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Clones a cache.
clone() - Method in class net.sf.ehcache.distribution.RMIAsynchronousCacheReplicator
Creates a clone of this listener.
clone() - Method in class net.sf.ehcache.distribution.RMIBootstrapCacheLoader
Clones this loader
clone() - Method in class net.sf.ehcache.distribution.RMISynchronousCacheReplicator
Creates a clone of this listener.
clone() - Method in interface net.sf.ehcache.Ehcache
Clones a cache.
clone() - Method in class net.sf.ehcache.Element
Clones an Element.
clone() - Method in interface net.sf.ehcache.event.CacheEventListener
Creates a clone of this listener.
clone(Ehcache) - Method in interface net.sf.ehcache.extension.CacheExtension
Creates a clone of this extension.
clone(Ehcache) - Method in interface net.sf.ehcache.loader.CacheLoader
Creates a clone of this extension.
Command - Interface in net.sf.ehcache.constructs.asynchronous
An asynchronous encapsulated command.
CommandNotFoundInCacheException - Exception in net.sf.ehcache.constructs.asynchronous
Thrown if a command id is in the queue but is not in the cache.
CommandNotFoundInCacheException(String) - Constructor for exception net.sf.ehcache.constructs.asynchronous.CommandNotFoundInCacheException
Constructs a new exception with the specified detail message.
CommandNotFoundInCacheException(String, Throwable) - Constructor for exception net.sf.ehcache.constructs.asynchronous.CommandNotFoundInCacheException
Constructs a new exception with the specified detail message and cause.
compare(Element, Element) - Method in class net.sf.ehcache.store.FifoPolicy
Compares the desirableness for eviction of two elements Compares hit counts.
compare(Element, Element) - Method in class net.sf.ehcache.store.LfuPolicy
Compares the desirableness for eviction of two elements Compares hit counts.
compare(Element, Element) - Method in class net.sf.ehcache.store.LruPolicy
Compares the desirableness for eviction of two elements Compares hit counts.
compare(Element, Element) - Method in interface net.sf.ehcache.store.Policy
Compares the desirableness for eviction of two elements
CONCURRENCY_LEVEL - Static variable in class net.sf.ehcache.store.MemoryStore
Set optimisation for 100 concurrent threads.
ConcurrencyUtil - Class in net.sf.ehcache.concurrent
Various bits of black magic garnered from experts on the concurrency-interest@cs.oswego.edu mailing list.
ConfigurableRMIClientSocketFactory - Class in net.sf.ehcache.distribution
Default socket timeouts are unlikely to be suitable for cache replication.
ConfigurableRMIClientSocketFactory(Integer) - Constructor for class net.sf.ehcache.distribution.ConfigurableRMIClientSocketFactory
Construct a new socket factory with the given timeout.
Configuration - Class in net.sf.ehcache.config
A bean, used by BeanUtils, to set configuration from an XML configuration file.
Configuration() - Constructor for class net.sf.ehcache.config.Configuration
Empty constructor, which is used by ConfigurationFactory, and can be also sued programmatically.
ConfigurationFactory - Class in net.sf.ehcache.config
A utility class which configures beans from XML, using reflection.
ConfigurationHelper - Class in net.sf.ehcache.config
The configuration for ehcache.
ConfigurationHelper(CacheManager, Configuration) - Constructor for class net.sf.ehcache.config.ConfigurationHelper
Only Constructor
containsKey(Object) - Method in class net.sf.ehcache.store.DiskStore
An unsynchronized and very low cost check to see if a key is in the Store.
containsKey(Object) - Method in class net.sf.ehcache.store.LruMemoryStore
An unsynchronized check to see if a key is in the Store.
containsKey(Object) - Method in class net.sf.ehcache.store.MemoryStore
A check to see if a key is in the Store.
containsKey(Object) - Method in interface net.sf.ehcache.store.Store
A check to see if a key is in the Store.
convertIntToStatus(int) - Static method in class net.sf.ehcache.Status
 
countCachedPublishCommands() - Method in class net.sf.ehcache.constructs.asynchronous.AsynchronousCommandExecutor
 
create() - Static method in class net.sf.ehcache.CacheManager
A factory method to create a singleton CacheManager with default config, or return it if it exists.
create(String) - Static method in class net.sf.ehcache.CacheManager
A factory method to create a singleton CacheManager with a specified configuration.
create(URL) - Static method in class net.sf.ehcache.CacheManager
A factory method to create a singleton CacheManager from an URL.
create(InputStream) - Static method in class net.sf.ehcache.CacheManager
A factory method to create a singleton CacheManager from a java.io.InputStream.
create(Ehcache, Store) - Static method in class net.sf.ehcache.store.MemoryStore
A factory method to create a MemoryStore.
createAutomaticallyConfiguredCachePeerProvider(CacheManager, Properties) - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerProviderFactory
peerDiscovery=automatic, multicastGroupAddress=230.0.0.1, multicastGroupPort=4446, multicastPacketTimeToLive=255
createBootstrapCacheLoader(Properties) - Method in class net.sf.ehcache.bootstrap.BootstrapCacheLoaderFactory
Create a BootstrapCacheLoader
createBootstrapCacheLoader(CacheConfiguration.BootstrapCacheLoaderFactoryConfiguration) - Method in class net.sf.ehcache.config.ConfigurationHelper
Tries to load a BootstrapCacheLoader from the class specified.
createBootstrapCacheLoader(Properties) - Method in class net.sf.ehcache.distribution.RMIBootstrapCacheLoaderFactory
Create a BootstrapCacheLoader
createCacheEventListener(Properties) - Method in class net.sf.ehcache.distribution.RMICacheReplicatorFactory
Create a CacheEventListener which is also a CacheReplicator.
createCacheEventListener(Properties) - Method in class net.sf.ehcache.event.CacheEventListenerFactory
Create a CacheEventListener
createCacheExceptionHandler(CacheConfiguration.CacheExceptionHandlerFactoryConfiguration) - Method in class net.sf.ehcache.config.ConfigurationHelper
Tries to create a CacheLoader from the configuration using the factory specified.
createCacheExtension(Ehcache, Properties) - Method in class net.sf.ehcache.extension.CacheExtensionFactory
 
createCacheLoader(Ehcache, Properties) - Method in class net.sf.ehcache.loader.CacheLoaderFactory
Creates a CacheLoader using the Ehcache configuration mechanism at the time the associated cache is created.
createCacheManagerEventListener() - Method in class net.sf.ehcache.config.ConfigurationHelper
Tries to load the class specified.
createCacheManagerEventListener(Properties) - Method in class net.sf.ehcache.event.CacheManagerEventListenerFactory
Create a CacheEventListener
createCachePeerListener(CacheManager, Properties) - Method in class net.sf.ehcache.distribution.CacheManagerPeerListenerFactory
Creates a peer provider.
createCachePeerListener(CacheManager, Properties) - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerListenerFactory
 
createCachePeerListeners() - Method in class net.sf.ehcache.config.ConfigurationHelper
Tries to load the class specified otherwise defaults to null
createCachePeerProvider(CacheManager, Properties) - Method in class net.sf.ehcache.distribution.CacheManagerPeerProviderFactory
Create a peer provider.
createCachePeerProvider(CacheManager, Properties) - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerProviderFactory
 
createCachePeerProviders() - Method in class net.sf.ehcache.config.ConfigurationHelper
Tries to load the class specified otherwise defaults to null
createCaches() - Method in class net.sf.ehcache.config.ConfigurationHelper
Creates unitialised caches for each cache configuration found
createDefaultCache() - Method in class net.sf.ehcache.config.ConfigurationHelper
 
createDiskStore() - Method in class net.sf.ehcache.Cache
Creates a disk store when either: overflowToDisk is enabled diskPersistent is enabled
createEntry(Object) - Method in interface net.sf.ehcache.constructs.blocking.CacheEntryFactory
Creates the cacheEntry for the given cache key.
createExceptionHandler(Properties) - Method in class net.sf.ehcache.exceptionhandler.CacheExceptionHandlerFactory
Create an CacheExceptionHandler
createManuallyConfiguredCachePeerProvider(Properties) - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerProviderFactory
peerDiscovery=manual, rmiUrls=//hostname:port/cacheName //hostname:port/cacheName //hostname:port/cacheName
createNewInstance(String) - Static method in class net.sf.ehcache.util.ClassLoaderUtil
Creates a new class instance.
createProxy(Ehcache) - Static method in class net.sf.ehcache.exceptionhandler.ExceptionHandlingDynamicCacheProxy
A simple factory method to hide the messiness of creating the proxy from clients.
createSocket(String, int) - Method in class net.sf.ehcache.distribution.ConfigurableRMIClientSocketFactory
Create a client socket connected to the specified host and port.

D

DEFAULT_ASYNCHRONOUS_REPLICATION_INTERVAL_MILLIS - Static variable in class net.sf.ehcache.distribution.RMICacheReplicatorFactory
A default for the amount of time the replication thread sleeps after it detects the replicationQueue is empty before checking again.
DEFAULT_CACHE_NAME - Static variable in class net.sf.ehcache.Cache
A reserved word for cache names.
DEFAULT_DISPATCHER_THREAD_INTERVAL_SECONDS - Static variable in class net.sf.ehcache.constructs.asynchronous.AsynchronousCommandExecutor
The dispatcher thread interval.
DEFAULT_EXPIRY_THREAD_INTERVAL_SECONDS - Static variable in class net.sf.ehcache.Cache
The default interval between runs of the expiry thread.
DEFAULT_LOAD_FACTOR - Static variable in class net.sf.ehcache.store.MemoryStore
This is the default from ConcurrentHashMap.
DEFAULT_MAXIMUM_CHUNK_SIZE_BYTES - Static variable in class net.sf.ehcache.distribution.RMIBootstrapCacheLoaderFactory
The default maximum serialized size of the elements to request from a remote cache peer during bootstrap.
DEFAULT_NUMBER_OF_MUTEXES - Static variable in class net.sf.ehcache.concurrent.StripedMutex
The default number of locks to use.
DEFAULT_SOCKET_TIMEOUT_MILLIS - Static variable in class net.sf.ehcache.distribution.RMICacheManagerPeerListenerFactory
The default timeout for cache replication for a single replication action.
destroy() - Method in class net.sf.ehcache.hibernate.EhCache
Remove the cache and make it unuseable.
determineEvictionPolicy(Ehcache) - Method in class net.sf.ehcache.store.MemoryStore
Chooses the Policy from the cache configuration
diskExpiryThreadIntervalSeconds - Variable in class net.sf.ehcache.config.CacheConfiguration
The interval in seconds between runs of the disk expiry thread.
diskPersistent - Variable in class net.sf.ehcache.config.CacheConfiguration
For caches that overflow to disk, whether the disk cache persists between CacheManager instances.
diskSpoolBufferSizeMB - Variable in class net.sf.ehcache.config.CacheConfiguration
The size of the disk spool used to buffer writes
DiskStore - Class in net.sf.ehcache.store
A disk store implementation.
DiskStore(Ehcache, String) - Constructor for class net.sf.ehcache.store.DiskStore
Creates a disk store.
diskStore - Variable in class net.sf.ehcache.store.LruMemoryStore
The DiskStore associated with this MemoryStore.
diskStore - Variable in class net.sf.ehcache.store.MemoryStore
The DiskStore associated with this MemoryStore.
DiskStoreConfiguration - Class in net.sf.ehcache.config
A class to represent DiskStore configuration e.g.
DiskStoreConfiguration() - Constructor for class net.sf.ehcache.config.DiskStoreConfiguration
 
dispose() - Method in class net.sf.ehcache.Cache
Starts an orderly shutdown of the Cache.
dispose() - Method in class net.sf.ehcache.constructs.asynchronous.AsynchronousCommandExecutor
ehcache also has a shutdown hook, so it will save all to disk.
dispose() - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Flushes all cache items from memory to auxilliary caches and close the auxilliary caches.
dispose() - Method in interface net.sf.ehcache.distribution.CacheManagerPeerProvider
Providers may be doing all sorts of exotic things and need to be able to clean up on dispose.
dispose() - Method in class net.sf.ehcache.distribution.MulticastKeepaliveHeartbeatReceiver
Shutdown the heartbeat.
dispose() - Method in class net.sf.ehcache.distribution.MulticastKeepaliveHeartbeatSender
Shutdown this heartbeat sender
dispose() - Method in class net.sf.ehcache.distribution.MulticastRMICacheManagerPeerProvider
Shutdown the heartbeat
dispose() - Method in class net.sf.ehcache.distribution.RMIAsynchronousCacheReplicator
Give the replicator a chance to flush the replication queue, then cleanup and free resources when no longer needed
dispose() - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerListener
Stop the listener.
dispose() - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerProvider
Providers may be doing all sorts of exotic things and need to be able to clean up on dispose.
dispose() - Method in class net.sf.ehcache.distribution.RMISynchronousCacheReplicator
Give the replicator a chance to cleanup and free resources when no longer needed
dispose() - Method in interface net.sf.ehcache.Ehcache
Flushes all cache items from memory to auxilliary caches and close the auxilliary caches.
dispose() - Method in interface net.sf.ehcache.event.CacheEventListener
Give the listener a chance to cleanup and free resources when no longer needed
dispose() - Method in interface net.sf.ehcache.event.CacheManagerEventListener
Stop the listener and free any resources.
dispose() - Method in class net.sf.ehcache.event.CacheManagerEventListenerRegistry
Tell listeners to dispose themselves.
dispose() - Method in class net.sf.ehcache.event.RegisteredEventListeners
Tell listeners to dispose themselves.
dispose() - Method in interface net.sf.ehcache.extension.CacheExtension
Providers may be doing all sorts of exotic things and need to be able to clean up on dispose.
dispose() - Method in interface net.sf.ehcache.loader.CacheLoader
Providers may be doing all sorts of exotic things and need to be able to clean up on dispose.
dispose() - Method in class net.sf.ehcache.management.ManagementService
Stop the listener and free any resources.
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.LruMemoryStore
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.
disposeRMICachePeer(RMICachePeer) - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerListener
A template method to dispose an individual RMICachePeer.
doCreateCachePeerListener(String, Integer, Integer, CacheManager, Integer) - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerListenerFactory
A template method to actually create the factory
doLoad(Ehcache) - Method in class net.sf.ehcache.distribution.RMIBootstrapCacheLoader
Bootstraps the cache from a random CachePeer.
doPut(Element) - Method in class net.sf.ehcache.store.LruMemoryStore
Allow specialised actions over adding the element to the map.
doPut(Element) - Method in class net.sf.ehcache.store.MemoryStore
Puts an element into the store

E

Ehcache - Interface in net.sf.ehcache
An interface for Ehcache.
EhCache - Class in net.sf.ehcache.hibernate
EHCache plugin for Hibernate.
EhCache(Ehcache) - Constructor for class net.sf.ehcache.hibernate.EhCache
Creates a new Hibernate pluggable cache by name.
EhCacheProvider - Class in net.sf.ehcache.hibernate
Cache Provider plugin for Hibernate 3.2 and ehcache-1.2.
EhCacheProvider() - Constructor for class net.sf.ehcache.hibernate.EhCacheProvider
 
ehcaches - Variable in class net.sf.ehcache.CacheManager
Ehcaches managed by this manager.
Element - Class in net.sf.ehcache
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(Object, Object, long) - Constructor for class net.sf.ehcache.Element
A full constructor.
Element(Object, Object, long, long, long, long, long, long) - Constructor for class net.sf.ehcache.Element
Constructor.
Element(Object, Object, Boolean, Integer, Integer) - Constructor for class net.sf.ehcache.Element
Constructor used by ehcache-server
Element(Serializable, Serializable) - Constructor for class net.sf.ehcache.Element
Constructor.
Element(Object, Object) - Constructor for class net.sf.ehcache.Element
Constructor.
ENABLE_SHUTDOWN_HOOK_PROPERTY - Static variable in class net.sf.ehcache.CacheManager
System property to enable creation of a shutdown hook for CacheManager.
equals(Object) - Method in class net.sf.ehcache.Cache
An equals method which follows the contract of Object.equals(Object)

An Cache is equal to another one if it implements Ehcache and has the same GUID.

equals(Object) - Method in class net.sf.ehcache.distribution.ConfigurableRMIClientSocketFactory
The standard hashCode method which is necessary for SocketFactory classes.
equals(Object) - Method in class net.sf.ehcache.Element
Equals comparison with another element, based on the key.
equals(Object) - Method in class net.sf.ehcache.Status
Indicates whether some other object is "equal to" this one.
equals(Status) - Method in class net.sf.ehcache.Status
Equality checker when the comparison object is of the same type.
eternal - Variable in class net.sf.ehcache.config.CacheConfiguration
Sets whether elements are eternal.
EventMessage - Class in net.sf.ehcache.distribution
An Event Message, in respect of a particular cache.
EventMessage(int, Serializable, Element) - Constructor for class net.sf.ehcache.distribution.EventMessage
Full constructor.
evict(Element) - Method in class net.sf.ehcache.store.LruMemoryStore
Evict the Element.
evict(Element) - Method in class net.sf.ehcache.store.MemoryStore
Evict the Element.
evictExpiredElements() - Method in class net.sf.ehcache.Cache
Causes all elements stored in the Cache to be synchronously checked for expiry, and if expired, evicted.
evictExpiredElements() - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Causes all elements stored in the Cache to be synchronously checked for expiry, and if expired, evicted.
evictExpiredElements() - Method in interface net.sf.ehcache.Ehcache
Causes all elements stored in the Cache to be synchronously checked for expiry, and if expired, evicted.
ExceptionHandlingDynamicCacheProxy - Class in net.sf.ehcache.exceptionhandler
A dynamic proxy which provides CacheException handling.
ExceptionHandlingDynamicCacheProxy(Ehcache) - Constructor for class net.sf.ehcache.exceptionhandler.ExceptionHandlingDynamicCacheProxy
Constructor: Use with something like:
execute() - Method in interface net.sf.ehcache.constructs.asynchronous.Command
Executes the command.
expireElements() - Method in class net.sf.ehcache.store.DiskStore
Removes expired elements.
expireElements() - Method in class net.sf.ehcache.store.LruMemoryStore
Expire all elsments.
expireElements() - Method in class net.sf.ehcache.store.MemoryStore
Expire all elsments.
expireElements() - Method in interface net.sf.ehcache.store.Store
Expire all elements.
extractAndLogProperty(String, Properties) - Static method in class net.sf.ehcache.util.PropertyUtil
 
extractAndLogProperty(String, Map) - Static method in class net.sf.ehcache.util.PropertyUtil
 
extractBootstrapAsynchronously(Properties) - Method in class net.sf.ehcache.distribution.RMIBootstrapCacheLoaderFactory
Extracts the value of bootstrapAsynchronously from the properties
extractMaximumChunkSizeBytes(Properties) - Method in class net.sf.ehcache.distribution.RMIBootstrapCacheLoaderFactory
 
extractReplicateAsynchronously(Properties) - Method in class net.sf.ehcache.distribution.RMICacheReplicatorFactory
Extracts the value of replicateAsynchronously from the properties
extractReplicatePuts(Properties) - Method in class net.sf.ehcache.distribution.RMICacheReplicatorFactory
Extracts the value of replicatePuts from the properties
extractReplicatePutsViaCopy(Properties) - Method in class net.sf.ehcache.distribution.RMICacheReplicatorFactory
Extracts the value of replicatePutsViaCopy from the properties
extractReplicateRemovals(Properties) - Method in class net.sf.ehcache.distribution.RMICacheReplicatorFactory
Extracts the value of replicateRemovals from the properties
extractReplicateUpdates(Properties) - Method in class net.sf.ehcache.distribution.RMICacheReplicatorFactory
Extracts the value of replicateUpdates from the properties
extractReplicateUpdatesViaCopy(Properties) - Method in class net.sf.ehcache.distribution.RMICacheReplicatorFactory
Extracts the value of replicateUpdatesViaCopy from the properties
extractReplicationIntervalMilis(Properties) - Method in class net.sf.ehcache.distribution.RMICacheReplicatorFactory
Extracts the value of asynchronousReplicationIntervalMillis.

F

factory - Variable in class net.sf.ehcache.constructs.blocking.SelfPopulatingCache
A factory for creating entries, given a key
FactoryConfiguration - Class in net.sf.ehcache.config
A class to represent the CacheManagerEventListener configuration.
FactoryConfiguration() - Constructor for class net.sf.ehcache.config.FactoryConfiguration
 
fetchAndPutElements(Ehcache, List, CachePeer) - Method in class net.sf.ehcache.distribution.RMIBootstrapCacheLoader
Fetches a chunk of elements from a remote cache peer
FIFO - Static variable in class net.sf.ehcache.store.MemoryStoreEvictionPolicy
FIFO - first in first out, the oldest element by creation time.
FifoPolicy - Class in net.sf.ehcache.store
Contains common LFU policy code for use between the LfuMemoryStore and the DiskStore, which also uses an LfuPolicy for evictions.
FifoPolicy() - Constructor for class net.sf.ehcache.store.FifoPolicy
 
findEvictionCandidate(Element) - Method in class net.sf.ehcache.store.MemoryStore
Find a "relatively" unused element, but not the element just added.
FIVE_KB - Static variable in class net.sf.ehcache.distribution.RMIBootstrapCacheLoaderFactory
The lowest reasonable chunk size in bytes
flush() - Method in class net.sf.ehcache.Cache
Flushes all cache items from memory to the disk store, and from the DiskStore to disk.
flush() - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Flushes all cache items from memory to the disk store, and from the DiskStore to disk.
flush() - Method in interface net.sf.ehcache.Ehcache
Flushes all cache items from memory to the disk store, and from the DiskStore to disk.
flush() - Method in class net.sf.ehcache.management.Cache
Flushes all cache items from memory to the disk store, and from the DiskStore to disk.
flush() - Method in interface net.sf.ehcache.management.CacheMBean
Flushes all cache items from memory to the disk store, and from the DiskStore to disk.
flush() - Method in class net.sf.ehcache.store.DiskStore
Flush the spool if persistent, so we don't lose any data.
flush() - Method in class net.sf.ehcache.store.LruMemoryStore
Flush to disk only if the cache is diskPersistent.
flush() - Method in class net.sf.ehcache.store.MemoryStore
Flush to disk only if the cache is diskPersistent.
flush() - Method in interface net.sf.ehcache.store.Store
Flush elements to persistent store.
fromString(String) - Static method in class net.sf.ehcache.store.MemoryStoreEvictionPolicy
Converts a string representation of the policy into a policy.
fullyQualifiedClassPath - Variable in class net.sf.ehcache.config.FactoryConfiguration
class name.

G

generateRandomSample(int) - Static method in class net.sf.ehcache.store.AbstractPolicy
Generates a random sample from a population
generateRandomSampleIndices(int) - Static method in class net.sf.ehcache.store.AbstractPolicy
Generates a random set of indices
generateUniqueDirectory() - Static method in class net.sf.ehcache.store.DiskStore
Generates a unique directory name for use in automatically creating a diskStorePath where there is a conflict.
get(Serializable) - Method in class net.sf.ehcache.Cache
Gets an element from the cache.
get(Object) - Method in class net.sf.ehcache.Cache
Gets an element from the cache.
get(Object) - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Looks up an entry.
get(Serializable) - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Gets an element from the cache.
get(Object) - Method in class net.sf.ehcache.constructs.blocking.SelfPopulatingCache
Looks up an entry.
get(Object) - Method in class net.sf.ehcache.constructs.blocking.UpdatingSelfPopulatingCache
Looks up an object.
get(Serializable) - Method in interface net.sf.ehcache.Ehcache
Gets an element from the cache.
get(Object) - Method in interface net.sf.ehcache.Ehcache
Gets an element from the cache.
get(Object) - Method in class net.sf.ehcache.hibernate.EhCache
Gets a value of an element which matches the given key.
get(Object) - Method in class net.sf.ehcache.store.DiskStore
Gets an Element from the Disk Store.
get(Object) - Method in class net.sf.ehcache.store.LruMemoryStore
Gets an item from the cache.
get(Object) - Method in class net.sf.ehcache.store.MemoryStore
Gets an item from the cache.
get(Object) - Method in interface net.sf.ehcache.store.Store
Gets an item from the cache.
getAllWithLoader(Collection, Object) - Method in class net.sf.ehcache.Cache
The getAll method will return, from the cache, a Map of the objects associated with the Collection of keys in argument "keys".
getAllWithLoader(Collection, Object) - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
This method is not appropriate to use with BlockingCache.
getAllWithLoader(Collection, Object) - Method in interface net.sf.ehcache.Ehcache
The getAll method will return, from the cache, a Map of the objects associated with the Collection of keys in argument "keys".
getAssociatedCache() - Method in class net.sf.ehcache.Statistics
 
getAssociatedCacheName() - Method in class net.sf.ehcache.management.CacheStatistics
 
getAssociatedCacheName() - Method in interface net.sf.ehcache.management.CacheStatisticsMBean
 
getAssociatedCacheName() - Method in class net.sf.ehcache.Statistics
 
getAverageGetTime() - Method in class net.sf.ehcache.Cache
The average get time in ms.
getAverageGetTime() - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
The average get time in ms.
getAverageGetTime() - Method in interface net.sf.ehcache.Ehcache
The average get time in ms.
getAverageGetTime() - Method in class net.sf.ehcache.Statistics
The average get time.
getBootstrapCacheLoader() - Method in class net.sf.ehcache.Cache
Accessor for the BootstrapCacheLoader associated with this cache.
getBootstrapCacheLoader() - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Accessor for the BootstrapCacheLoader associated with this cache.
getBootstrapCacheLoader() - Method in interface net.sf.ehcache.Ehcache
Accessor for the BootstrapCacheLoader associated with this cache.
getBootstrapCacheLoaderFactoryConfiguration() - Method in class net.sf.ehcache.config.CacheConfiguration
Accessor
getBoundCachePeers() - Method in interface net.sf.ehcache.distribution.CacheManagerPeerListener
All of the caches which are listening for remote changes.
getBoundCachePeers() - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerListener
All of the caches which are listening for remote changes.
getBytes() - Method in class net.sf.ehcache.util.MemoryEfficientByteArrayOutputStream
Gets the bytes.
getCache(String) - Method in class net.sf.ehcache.CacheManager
Returns a concrete implementation of Cache, it it is available in the CacheManager.
getCache() - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Retrieve the EHCache backing cache
getCache(String) - Method in class net.sf.ehcache.management.CacheManager
Returns a JMX Cache bean
getCache(String) - Method in interface net.sf.ehcache.management.CacheManagerMBean
Returns a JMX Cache bean
getCacheConfiguration() - Method in class net.sf.ehcache.Cache
Gets the cache configuration this cache was created with.
getCacheConfiguration() - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Gets the cache configuration this cache was created with.
getCacheConfiguration() - Method in interface net.sf.ehcache.Ehcache
Gets the cache configuration this cache was created with.
getCacheConfiguration() - Method in class net.sf.ehcache.management.Cache
Gets the JMX read-only CacheConfiguration
getCacheConfiguration() - Method in interface net.sf.ehcache.management.CacheMBean
Gets the JMX read-only CacheConfiguration
getCacheConfigurations() - Method in class net.sf.ehcache.config.Configuration
Gets a Map of cache configurations, keyed by name.
getCacheConfigurationsKeySet() - Method in class net.sf.ehcache.config.Configuration
Gets a Map of cacheConfigurations.
getCacheEventListenerConfigurations() - Method in class net.sf.ehcache.config.CacheConfiguration
Accessor
getCacheEventListeners() - Method in class net.sf.ehcache.event.RegisteredEventListeners
Gets a list of the listeners registered to this class
getCacheEventNotificationService() - Method in class net.sf.ehcache.Cache
Use this to access the service in order to register and unregister listeners
getCacheEventNotificationService() - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Use this to access the service in order to register and unregister listeners
getCacheEventNotificationService() - Method in interface net.sf.ehcache.Ehcache
Use this to access the service in order to register and unregister listeners
getCacheExceptionHandler() - Method in class net.sf.ehcache.Cache
Gets the ExceptionHandler on this Cache, or null if there isn't one.
getCacheExceptionHandler() - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Sets an ExceptionHandler on the Cache.
getCacheExceptionHandler() - Method in interface net.sf.ehcache.Ehcache
Sets an ExceptionHandler on the Cache.
getCacheExceptionHandlerFactoryConfiguration() - Method in class net.sf.ehcache.config.CacheConfiguration
Accessor
getCacheExtensionConfigurations() - Method in class net.sf.ehcache.config.CacheConfiguration
Accessor
getCacheHits() - Method in class net.sf.ehcache.management.CacheStatistics
The number of times a requested item was found in the cache.
getCacheHits() - Method in interface net.sf.ehcache.management.CacheStatisticsMBean
The number of times a requested item was found in the cache.
getCacheHits() - Method in class net.sf.ehcache.Statistics
The number of times a requested item was found in the cache.
getCacheLoaderConfigurations() - Method in class net.sf.ehcache.config.CacheConfiguration
Accessor
getCacheManager() - Method in class net.sf.ehcache.Cache
Gets the CacheManager managing this cache.
getCacheManager() - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Gets the CacheManager managing this cache.
getCacheManager() - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerProvider
The cacheManager this provider is bound to
getCacheManager() - Method in interface net.sf.ehcache.Ehcache
Gets the CacheManager managing this cache.
getCacheManagerEventListener() - Method in class net.sf.ehcache.CacheManager
Returns the composite listener.
getCacheManagerEventListenerFactoryConfiguration() - Method in class net.sf.ehcache.config.Configuration
Gets the CacheManagerEventListener factory configuration.
getCacheManagerEventListenerRegistry() - Method in class net.sf.ehcache.CacheManager
Gets the CacheManagerEventListenerRegistry.
getCacheManagerPeerListenerFactoryConfigurations() - Method in class net.sf.ehcache.config.Configuration
Gets the CacheManagerPeerListener factory configuration.
getCacheManagerPeerProvider(String) - Method in class net.sf.ehcache.CacheManager
Gets the CacheManagerPeerProvider, matching the given scheme For distributed caches, the peer provider finds other cache managers and their caches in the same cluster
getCacheManagerPeerProviderFactoryConfiguration() - Method in class net.sf.ehcache.config.Configuration
Gets the CacheManagerPeerProvider factory configuration.
getCacheMisses() - Method in class net.sf.ehcache.management.CacheStatistics
Warning.
getCacheMisses() - Method in interface net.sf.ehcache.management.CacheStatisticsMBean
 
getCacheMisses() - Method in class net.sf.ehcache.Statistics
 
getCacheNames() - Method in class net.sf.ehcache.CacheManager
Returns a list of the current cache names.
getCacheNames() - Method in class net.sf.ehcache.management.CacheManager
Gets the cache names managed by the CacheManager
getCacheNames() - Method in interface net.sf.ehcache.management.CacheManagerMBean
Gets the cache names managed by the CacheManager
getCachePeer() - Method in class net.sf.ehcache.distribution.MulticastRMICacheManagerPeerProvider.CachePeerEntry
 
getCachePeerListener(String) - Method in class net.sf.ehcache.CacheManager
When CacheManage is configured as part of a cluster, a CacheManagerPeerListener will be registered in it.
getCaches() - Method in class net.sf.ehcache.management.CacheManager
Gets a list of caches in this CacheManager
getCaches() - Method in interface net.sf.ehcache.management.CacheManagerMBean
Gets a list of caches in this CacheManager
getConfigurationBean() - Method in class net.sf.ehcache.config.ConfigurationHelper
 
getConfigurationSource() - Method in class net.sf.ehcache.config.Configuration
Gets a description of the source from which this configuration was created.
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
Creates a file system safe data file.
getDataFilePath() - Method in class net.sf.ehcache.store.DiskStore
 
getDataFileSize() - Method in class net.sf.ehcache.store.DiskStore
 
getDate() - Method in class net.sf.ehcache.distribution.MulticastRMICacheManagerPeerProvider.CachePeerEntry
 
getDefaultCacheConfiguration() - Method in class net.sf.ehcache.config.Configuration
 
getDefaultPath() - Static method in class net.sf.ehcache.config.DiskStoreConfiguration
The diskStore default path, which is the system environment variable availablen on all Java virtual machines java.io.tmpdir
getDelayBetweenAttemptsInSeconds() - Method in interface net.sf.ehcache.constructs.asynchronous.Command
 
getDiskExpiryThreadIntervalSeconds() - Method in class net.sf.ehcache.config.CacheConfiguration
Accessor
getDiskExpiryThreadIntervalSeconds() - Method in class net.sf.ehcache.management.CacheConfiguration
Accessor
getDiskExpiryThreadIntervalSeconds() - Method in interface net.sf.ehcache.management.CacheConfigurationMBean
Accessor
getDiskSpoolBufferSizeMB() - Method in class net.sf.ehcache.config.CacheConfiguration
Getter
getDiskSpoolBufferSizeMB() - Method in class net.sf.ehcache.management.CacheConfiguration
Accessor
getDiskStoreConfiguration() - Method in class net.sf.ehcache.config.Configuration
Gets the disk store configuration.
getDiskStoreObjectCount() - Method in class net.sf.ehcache.management.CacheStatistics
Gets the number of objects in the DiskStore
getDiskStoreObjectCount() - Method in interface net.sf.ehcache.management.CacheStatisticsMBean
Gets the number of objects in the DiskStore
getDiskStoreObjectCount() - Method in class net.sf.ehcache.Statistics
 
getDiskStorePath() - Method in class net.sf.ehcache.CacheManager
Returns the disk store path.
getDiskStorePath() - Method in class net.sf.ehcache.config.ConfigurationHelper
 
getDiskStoreSize() - Method in class net.sf.ehcache.Cache
Returns the number of elements in the disk store.
getDiskStoreSize() - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Returns the number of elements in the disk store.
getDiskStoreSize() - Method in interface net.sf.ehcache.Ehcache
Returns the number of elements in the disk store.
getEhcache(String) - Method in class net.sf.ehcache.CacheManager
Gets an Ehcache

getEhcache() - Method in class net.sf.ehcache.management.CacheStatistics
Return the backing cache.
getElement() - Method in class net.sf.ehcache.distribution.EventMessage
 
getElementCountInMemory() - Method in class net.sf.ehcache.hibernate.EhCache
 
getElementCountOnDisk() - Method in class net.sf.ehcache.hibernate.EhCache
 
getElements(List) - Method in interface net.sf.ehcache.distribution.CachePeer
Gets a list of elements from the cache, for a list of keys, without updating Element statistics.
getElements(List) - Method in class net.sf.ehcache.distribution.RMICachePeer
Gets a list of elements from the cache, for a list of keys, without updating Element statistics.
getElementsEvictedCounter() - Method in class net.sf.ehcache.event.RegisteredEventListeners
Gets the number of events, irrespective of whether there are any registered listeners.
getElementsExpiredCounter() - Method in class net.sf.ehcache.event.RegisteredEventListeners
Gets the number of events, irrespective of whether there are any registered listeners.
getElementsPutCounter() - Method in class net.sf.ehcache.event.RegisteredEventListeners
Gets the number of events, irrespective of whether there are any registered listeners.
getElementsRemoveAllCounter() - Method in class net.sf.ehcache.event.RegisteredEventListeners
Gets the number of events, irrespective of whether there are any registered listeners.
getElementsRemovedCounter() - Method in class net.sf.ehcache.event.RegisteredEventListeners
Gets the number of events, irrespective of whether there are any registered listeners.
getElementsUpdatedCounter() - Method in class net.sf.ehcache.event.RegisteredEventListeners
Gets the number of events, irrespective of whether there are any registered listeners.
getEvent() - Method in class net.sf.ehcache.distribution.EventMessage
Gets the event.
getEvictionCount() - Method in class net.sf.ehcache.Statistics
Gets the number of cache evictions, since the cache was created, or statistics were cleared.
getEvictionPolicy() - Method in class net.sf.ehcache.store.DiskStore
 
getEvictionPolicy() - Method in class net.sf.ehcache.store.LruMemoryStore
 
getEvictionPolicy() - Method in class net.sf.ehcache.store.MemoryStore
 
getEvictionPolicy() - Method in interface net.sf.ehcache.store.Store
 
getExecuteAttemptsForCommand(String) - Method in class net.sf.ehcache.constructs.asynchronous.AsynchronousCommandExecutor
Gets the number of attempts for the command so far
getExpirationTime() - Method in class net.sf.ehcache.Element
Returns the expiration time based on time to live.
getFallbackClassLoader() - Static method in class net.sf.ehcache.util.ClassLoaderUtil
Gets a fallback ClassLoader that all classes in ehcache, and extensions, should use for classloading.
getFreePort() - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerListener
Gets a free server socket port.
getFullyQualifiedClassPath() - Method in class net.sf.ehcache.config.FactoryConfiguration
Getter.
getGuid() - Method in class net.sf.ehcache.Cache
The GUID for this cache instance can be used to determine whether two cache instance references are pointing to the same cache.
getGuid() - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
The GUID for this cache instance can be used to determine whether two cache instance references are pointing to the same cache.
getGuid() - Method in interface net.sf.ehcache.distribution.CachePeer
Gets the globally unique id for the underlying Cache instance.
getGuid() - Method in class net.sf.ehcache.distribution.RMICachePeer
Gets the globally unique id for the underlying Cache instance.
getGuid() - Method in interface net.sf.ehcache.Ehcache
The GUID for this cache instance can be used to determine whether two cache instance references are pointing to the same cache.
getHeartBeatInterval() - Static method in class net.sf.ehcache.distribution.MulticastKeepaliveHeartbeatSender
Returns the heartbeat interval.
getHeartBeatReceiver() - Method in class net.sf.ehcache.distribution.MulticastRMICacheManagerPeerProvider
 
getHeartBeatSender() - Method in class net.sf.ehcache.distribution.MulticastRMICacheManagerPeerProvider
 
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
 
getInMemoryHits() - Method in class net.sf.ehcache.management.CacheStatistics
Number of times a requested item was found in the Memory Store.
getInMemoryHits() - Method in interface net.sf.ehcache.management.CacheStatisticsMBean
Number of times a requested item was found in the Memory Store.
getInMemoryHits() - Method in class net.sf.ehcache.Statistics
Number of times a requested item was found in the Memory Store.
getInstance() - Static method in class net.sf.ehcache.CacheManager
A factory method to create a singleton CacheManager with default config, or return it if it exists.
getInstance() - Static method in class net.sf.ehcache.constructs.asynchronous.AsynchronousCommandExecutor
Factory method to get an instance of MessageDispatcher.
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.LruMemoryStore
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.
getKeyArray() - Method in interface net.sf.ehcache.store.Store
Gets an Array of the keys for all elements in the disk store.
getKeys() - Method in class net.sf.ehcache.Cache
Returns a list of all element keys in the cache, whether or not they are expired.
getKeys() - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Returns the keys for this cache.
getKeys() - Method in interface net.sf.ehcache.distribution.CachePeer
Returns a list of all elements in the cache, whether or not they are expired.
getKeys() - Method in class net.sf.ehcache.distribution.RMICachePeer
Returns a list of all elements in the cache, whether or not they are expired.
getKeys() - Method in interface net.sf.ehcache.Ehcache
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.
getKeysNoDuplicateCheck() - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Returns a list of all elements in the cache, whether or not they are expired.
getKeysNoDuplicateCheck() - Method in interface net.sf.ehcache.Ehcache
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 element keys in the cache.
getKeysWithExpiryCheck() - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Returns a list of all elements in the cache.
getKeysWithExpiryCheck() - Method in interface net.sf.ehcache.Ehcache
Returns a list of all elements in the cache.
getLastAccessTime() - Method in class net.sf.ehcache.Element
Gets the last access time.
getLastUpdateTime() - Method in class net.sf.ehcache.Element
If there is an Element in the Cache and it is replaced with a new Element for the same key, then both the version number and lastUpdateTime should be updated to reflect that.
getLatestOfCreationAndUpdateTime() - Method in class net.sf.ehcache.Element
Calculates the latest of creation and update time
getMaxElementsInMemory() - Method in class net.sf.ehcache.config.CacheConfiguration
Accessor
getMaxElementsInMemory() - Method in class net.sf.ehcache.management.CacheConfiguration
Accessor
getMaxElementsInMemory() - Method in interface net.sf.ehcache.management.CacheConfigurationMBean
Accessor
getMaxElementsOnDisk() - Method in class net.sf.ehcache.config.CacheConfiguration
Accessor
getMaxElementsOnDisk() - Method in class net.sf.ehcache.management.CacheConfiguration
Accessor
getMaxElementsOnDisk() - Method in interface net.sf.ehcache.management.CacheConfigurationMBean
Accessor
getMaximumChunkSizeBytes() - Method in class net.sf.ehcache.distribution.RMIBootstrapCacheLoader
Gets the maximum chunk size
getMemoryStoreEvictionPolicy() - Method in class net.sf.ehcache.Cache
 
getMemoryStoreEvictionPolicy() - Method in class net.sf.ehcache.config.CacheConfiguration
Accessor
getMemoryStoreEvictionPolicy() - Method in class net.sf.ehcache.management.CacheConfiguration
Accessor
getMemoryStoreEvictionPolicy() - Method in interface net.sf.ehcache.management.CacheConfigurationMBean
Accessor
getMemoryStoreObjectCount() - Method in class net.sf.ehcache.management.CacheStatistics
Gets the number of objects in the MemoryStore
getMemoryStoreObjectCount() - Method in interface net.sf.ehcache.management.CacheStatisticsMBean
Gets the number of objects in the MemoryStore
getMemoryStoreObjectCount() - Method in class net.sf.ehcache.Statistics
 
getMemoryStoreSize() - Method in class net.sf.ehcache.Cache
Returns the number of elements in the memory store.
getMemoryStoreSize() - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Returns the number of elements in the memory store.
getMemoryStoreSize() - Method in interface net.sf.ehcache.Ehcache
Returns the number of elements in the memory store.
getMessageCache() - Method in class net.sf.ehcache.constructs.asynchronous.AsynchronousCommandExecutor
Gets the message cache
getMimeType() - Method in class net.sf.ehcache.MimeTypeByteArray
 
getMutexForKey(Object) - Method in class net.sf.ehcache.concurrent.StripedMutex
Gets the Mutex Stripe to use for a given key.
getName() - Method in class net.sf.ehcache.Cache
Gets the cache name.
getName() - Method in class net.sf.ehcache.CacheManager
Gets the name of the CacheManager.
getName() - Method in class net.sf.ehcache.config.CacheConfiguration
Accessor
getName() - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Returns this cache's name
getName() - Method in interface net.sf.ehcache.distribution.CachePeer
Gets the cache name.
getName() - Method in class net.sf.ehcache.distribution.RMICachePeer
Gets the cache name
getName() - Method in interface net.sf.ehcache.Ehcache
Gets the cache name.
getName() - Method in interface net.sf.ehcache.loader.CacheLoader
Gets the name of a CacheLoader
getName() - Method in class net.sf.ehcache.management.Cache
Gets the cache name.
getName() - Method in class net.sf.ehcache.management.CacheConfiguration
Accessor
getName() - Method in interface net.sf.ehcache.management.CacheConfigurationMBean
Accessor
getName() - Method in interface net.sf.ehcache.management.CacheMBean
Gets the cache name.
getName() - Method in class net.sf.ehcache.store.FifoPolicy
 
getName() - Method in class net.sf.ehcache.store.LfuPolicy
 
getName() - Method in class net.sf.ehcache.store.LruPolicy
 
getName() - Method in interface net.sf.ehcache.store.Policy
 
getNextToLastAccessTime() - Method in class net.sf.ehcache.Element
Gets the next to last access time.
getNumberOfAttempts() - Method in interface net.sf.ehcache.constructs.asynchronous.Command
 
getObjectCount() - Method in class net.sf.ehcache.management.CacheStatistics
Gets the number of elements stored in the cache.
getObjectCount() - Method in interface net.sf.ehcache.management.CacheStatisticsMBean
Gets the number of elements stored in the cache.
getObjectCount() - Method in class net.sf.ehcache.Statistics
Gets the number of elements stored in the cache.
getObjectKey() - Method in class net.sf.ehcache.Element
Gets the key attribute of the Element object.
getObjectValue() - Method in class net.sf.ehcache.Element
Gets the value attribute of the Element object as an Object.
getOnDiskHits() - Method in class net.sf.ehcache.management.CacheStatistics
Number of times a requested item was found in the Disk Store.
getOnDiskHits() - Method in interface net.sf.ehcache.management.CacheStatisticsMBean
Number of times a requested item was found in the Disk Store.
getOnDiskHits() - Method in class net.sf.ehcache.Statistics
Number of times a requested item was found in the Disk Store.
getPath() - Method in class net.sf.ehcache.config.DiskStoreConfiguration
The diskStore path
getProperties() - Method in class net.sf.ehcache.config.FactoryConfiguration
Getter.
getPropertySeparator() - Method in class net.sf.ehcache.config.FactoryConfiguration
Getter
getQuiet(Serializable) - Method in class net.sf.ehcache.Cache
Gets an element from the cache, without updating Element statistics.
getQuiet(Object) - 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.constructs.blocking.BlockingCache
Gets an element from the cache, without updating Element statistics.
getQuiet(Object) - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Gets an element from the cache, without updating Element statistics.
getQuiet(Serializable) - Method in interface net.sf.ehcache.distribution.CachePeer
Gets an element from the cache, without updating Element statistics.
getQuiet(Serializable) - Method in class net.sf.ehcache.distribution.RMICachePeer
Gets an element from the cache, without updating Element statistics.
getQuiet(Serializable) - Method in interface net.sf.ehcache.Ehcache
Gets an element from the cache, without updating Element statistics.
getQuiet(Object) - Method in interface net.sf.ehcache.Ehcache
Gets an element from the cache, without updating Element statistics.
getQuiet(Object) - Method in class net.sf.ehcache.store.DiskStore
Gets an Element from the Disk Store, without updating statistics
getQuiet(Object) - Method in class net.sf.ehcache.store.LruMemoryStore
Gets an item from the cache, without updating statistics.
getQuiet(Object) - Method in class net.sf.ehcache.store.MemoryStore
Gets an item from the cache, without updating statistics.
getQuiet(Object) - Method in interface net.sf.ehcache.store.Store
Gets an Element from the Store, without updating statistics
getRegionName() - Method in class net.sf.ehcache.hibernate.EhCache
 
getRegisteredCacheExtensions() - Method in class net.sf.ehcache.Cache
 
getRegisteredCacheExtensions() - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
 
getRegisteredCacheExtensions() - Method in interface net.sf.ehcache.Ehcache
 
getRegisteredCacheLoaders() - Method in class net.sf.ehcache.Cache
 
getRegisteredCacheLoaders() - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
 
getRegisteredCacheLoaders() - Method in interface net.sf.ehcache.Ehcache
 
getRegisteredListeners() - Method in class net.sf.ehcache.event.CacheManagerEventListenerRegistry
Gets a Set of the listeners registered to this class
getScheme() - Method in interface net.sf.ehcache.distribution.CacheManagerPeerListener
The replication scheme this listener interacts with.
getScheme() - Method in interface net.sf.ehcache.distribution.CacheManagerPeerProvider
The replication scheme.
getScheme() - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerListener
The replication scheme this listener interacts with.
getScheme() - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerProvider
The replication scheme.
getSerializableKey() - Method in class net.sf.ehcache.distribution.EventMessage
 
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.constructs.blocking.BlockingCache
Gets the size of the cache.
getSize() - Method in interface net.sf.ehcache.Ehcache
Gets the size of the cache.
getSize() - Method in class net.sf.ehcache.store.DiskStore
Returns the current store size in number of Elements.
getSize() - Method in class net.sf.ehcache.store.LruMemoryStore
Returns the current cache size.
getSize() - Method in class net.sf.ehcache.store.MemoryStore
Returns the current store size.
getSize() - Method in interface net.sf.ehcache.store.Store
Returns the current store size
getSizeInBytes() - Method in class net.sf.ehcache.store.DiskStore
Gets the size of the store, in bytes.
getSizeInBytes() - Method in class net.sf.ehcache.store.LruMemoryStore
Measures the size of the memory store by measuring the serialized size of all elements.
getSizeInBytes() - Method in class net.sf.ehcache.store.MemoryStore
Measures the size of the memory store by measuring the serialized size of all elements.
getSizeInBytes() - Method in interface net.sf.ehcache.store.Store
Gets the size of the store, in bytes.
getSizeInMemory() - Method in class net.sf.ehcache.hibernate.EhCache
Warning: This method can be very expensive to run.
getStaleTime() - Method in class net.sf.ehcache.distribution.MulticastRMICacheManagerPeerProvider
The time after which an unrefreshed peer provider entry is considered stale.
getStandardClassLoader() - Static method in class net.sf.ehcache.util.ClassLoaderUtil
Gets the ClassLoader that all classes in ehcache, and extensions, should use for classloading.
getStatistics() - Method in class net.sf.ehcache.Cache
Gets an immutable Statistics object representing the Cache statistics at the time.
getStatistics() - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Gets an immutable Statistics object representing the Cache statistics at the time.
getStatistics() - Method in interface net.sf.ehcache.Ehcache
Gets an immutable Statistics object representing the Cache statistics at the time.
getStatistics() - Method in class net.sf.ehcache.management.Cache
Gets the JMX cache statistics
getStatistics() - Method in interface net.sf.ehcache.management.CacheMBean
Gets the JMX cache statistics
getStatisticsAccuracy() - Method in class net.sf.ehcache.Cache
Accurately measuring statistics can be expensive.
getStatisticsAccuracy() - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Accurately measuring statistics can be expensive.
getStatisticsAccuracy() - Method in interface net.sf.ehcache.Ehcache
Accurately measuring statistics can be expensive.
getStatisticsAccuracy() - Method in class net.sf.ehcache.management.CacheStatistics
Accurately measuring statistics can be expensive.
getStatisticsAccuracy() - Method in interface net.sf.ehcache.management.CacheStatisticsMBean
Accurately measuring statistics can be expensive.
getStatisticsAccuracy() - Method in class net.sf.ehcache.Statistics
Accurately measuring statistics can be expensive.
getStatisticsAccuracyDescription() - Method in class net.sf.ehcache.management.CacheStatistics
Accurately measuring statistics can be expensive.
getStatisticsAccuracyDescription() - Method in interface net.sf.ehcache.management.CacheStatisticsMBean
Accurately measuring statistics can be expensive.
getStatisticsAccuracyDescription() - Method in class net.sf.ehcache.Statistics
Accurately measuring statistics can be expensive.
getStatus() - Method in class net.sf.ehcache.Cache
Gets the status attribute of the Cache.
getStatus() - Method in class net.sf.ehcache.CacheManager
Gets the status attribute of the Ehcache
getStatus() - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Gets the status attribute of the Cache.
getStatus() - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerListener
Returns the listener status.
getStatus() - Method in interface net.sf.ehcache.Ehcache
Gets the status attribute of the Cache.
getStatus() - Method in interface net.sf.ehcache.event.CacheManagerEventListener
Returns the listener status.
getStatus() - Method in class net.sf.ehcache.event.CacheManagerEventListenerRegistry
Returns the listener status.
getStatus() - Method in interface net.sf.ehcache.extension.CacheExtension
 
getStatus() - Method in interface net.sf.ehcache.loader.CacheLoader
 
getStatus() - Method in class net.sf.ehcache.management.Cache
Gets the status attribute of the Cache.
getStatus() - Method in class net.sf.ehcache.management.CacheManager
Gets the status attribute of the Ehcache
getStatus() - Method in interface net.sf.ehcache.management.CacheManagerMBean
Gets the status attribute of the Ehcache
getStatus() - Method in interface net.sf.ehcache.management.CacheMBean
Gets the status attribute of the Cache.
getStatus() - Method in class net.sf.ehcache.management.ManagementService
Returns the listener status.
getStatus() - Method in class net.sf.ehcache.store.DiskStore
Returns the store status.
getStatus() - Method in class net.sf.ehcache.store.LruMemoryStore
Gets the status of the MemoryStore.
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.
getThrowablesToRetryOn() - Method in interface net.sf.ehcache.constructs.asynchronous.Command
The AsynchronousCommandExecutor may also be fault tolerant.
getTimeForClusterToForm() - Method in interface net.sf.ehcache.distribution.CacheManagerPeerProvider
Time for a cluster to form.
getTimeForClusterToForm() - Method in class net.sf.ehcache.distribution.ManualRMICacheManagerPeerProvider
Time for a cluster to form.
getTimeForClusterToForm() - Method in class net.sf.ehcache.distribution.MulticastRMICacheManagerPeerProvider
Time for a cluster to form.
getTimeout() - Method in class net.sf.ehcache.hibernate.EhCache
Returns the lock timeout for this cache, which is 60s
getTimeoutMillis() - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Gets the time to wait to acquire a lock.
getTimeToIdle() - Method in class net.sf.ehcache.Element
 
getTimeToIdleSeconds() - Method in class net.sf.ehcache.config.CacheConfiguration
Accessor
getTimeToIdleSeconds() - Method in class net.sf.ehcache.management.CacheConfiguration
Accessor
getTimeToIdleSeconds() - Method in interface net.sf.ehcache.management.CacheConfigurationMBean
Accessor
getTimeToLive() - Method in class net.sf.ehcache.distribution.MulticastKeepaliveHeartbeatSender
 
getTimeToLive() - Method in class net.sf.ehcache.Element
 
getTimeToLiveSeconds() - Method in class net.sf.ehcache.config.CacheConfiguration
Accessor
getTimeToLiveSeconds() - Method in class net.sf.ehcache.management.CacheConfiguration
Accessor
getTimeToLiveSeconds() - Method in interface net.sf.ehcache.management.CacheConfigurationMBean
Accessor
getTotalFileSize() - Method in class net.sf.ehcache.store.DiskStore
 
getUniqueResourceIdentifier() - Method in interface net.sf.ehcache.distribution.CacheManagerPeerListener
A listener will normally have a resource that only one instance can use at the same time, such as a port.
getUniqueResourceIdentifier() - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerListener
A listener will normally have a resource that only one instance can use at the same time, such as a port.
getUrl() - Method in interface net.sf.ehcache.distribution.CachePeer
The URL for the remote replicator to connect.
getUrl() - Method in class net.sf.ehcache.distribution.RMICachePeer
The URL for the remote replicator to connect.
getUrlBase() - Method in interface net.sf.ehcache.distribution.CachePeer
The URL base for the remote replicator to connect.
getUrlBase() - Method in class net.sf.ehcache.distribution.RMICachePeer
The URL base for the remote replicator to connect.
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.
getValue() - Method in class net.sf.ehcache.MimeTypeByteArray
 
getVersion() - Method in class net.sf.ehcache.Element
Gets the version attribute of the ElementAttributes object.
getWithLoader(Object, CacheLoader, Object) - Method in class net.sf.ehcache.Cache
This method will return, from the cache, the Element associated with the argument "key".
getWithLoader(Object, CacheLoader, Object) - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
This method is not appropriate to use with BlockingCache.
getWithLoader(Object, CacheLoader, Object) - Method in interface net.sf.ehcache.Ehcache
This method will return, from the cache, the object associated with the argument "key".

H

hasCacheEventListeners() - Method in class net.sf.ehcache.event.RegisteredEventListeners
Returns whether or not at least one cache event listeners has been registered.
hash(Object) - Static method in class net.sf.ehcache.concurrent.ConcurrencyUtil
Returns a hash code for non-null Object x.
hashCode() - Method in class net.sf.ehcache.Cache
Returns a hash code value for the object.
hashCode() - Method in class net.sf.ehcache.distribution.ConfigurableRMIClientSocketFactory
Implements the Object hashCode method.
hashCode() - Method in class net.sf.ehcache.Element
Gets the hashcode, based on the key.
hashCode() - Method in class net.sf.ehcache.Status
Returns a hash code value for Status.
hasRegisteredListeners() - Method in class net.sf.ehcache.event.CacheManagerEventListenerRegistry
Returns whether or not at least one cache manager event listeners has been registered.

I

incrementIndex() - Method in class net.sf.ehcache.store.MemoryStore
A bounds-safe incrementer, which loops back to zero when it exceeds the array size
init(Configuration, String, URL, InputStream) - Method in class net.sf.ehcache.CacheManager
initialises the CacheManager
init() - Method in interface net.sf.ehcache.distribution.CacheManagerPeerProvider
Notifies providers to initialise themselves.
init() - Method in class net.sf.ehcache.distribution.ManualRMICacheManagerPeerProvider
Notifies providers to initialise themselves.
init() - Method in class net.sf.ehcache.distribution.MulticastKeepaliveHeartbeatSender
Start the heartbeat thread
init() - Method in class net.sf.ehcache.distribution.MulticastRMICacheManagerPeerProvider
Notifies providers to initialise themselves.
init() - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerListener
Call to start the listeners and do any other required initialisation.
init() - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerProvider
Notifies providers to initialise themselves.
init() - Method in interface net.sf.ehcache.event.CacheManagerEventListener
Call to start the listeners and do any other required initialisation.
init() - Method in class net.sf.ehcache.event.CacheManagerEventListenerRegistry
Initialises the listeners, ready to receive events.
init() - Method in interface net.sf.ehcache.extension.CacheExtension
Notifies providers to initialise themselves.
init() - Method in interface net.sf.ehcache.loader.CacheLoader
Notifies providers to initialise themselves.
init() - Method in class net.sf.ehcache.management.ManagementService
Call to register the mbeans in the mbean server and start the event listeners and do any other required initialisation.
initialise() - Method in class net.sf.ehcache.Cache
Newly created caches do not have a MemoryStore or a DiskStore.
initialise() - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Newly created caches do not have a MemoryStore or a DiskStore.
initialise() - Method in interface net.sf.ehcache.Ehcache
Newly created caches do not have a MemoryStore or a DiskStore.
intValue() - Method in class net.sf.ehcache.Status
Returns the int value of status, for backward compatibility with ehcache versions below 1.2
inUse - Variable in class net.sf.ehcache.concurrent.Mutex
The lock status *
invoke(Object, Method, Object[]) - Method in class net.sf.ehcache.exceptionhandler.ExceptionHandlingDynamicCacheProxy
Processes a method invocation on a proxy instance and returns the result.
isAsynchronous() - Method in interface net.sf.ehcache.bootstrap.BootstrapCacheLoader
 
isAsynchronous() - Method in class net.sf.ehcache.distribution.RMIBootstrapCacheLoader
 
isClearOnFlush() - Method in class net.sf.ehcache.config.CacheConfiguration
Accessor
isDisabled() - Method in class net.sf.ehcache.Cache
Whether this cache is disabled.
isDisabled() - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Whether this cache is disabled.
isDisabled() - Method in interface net.sf.ehcache.Ehcache
Whether this cache is disabled.
isDiskPersistent() - Method in class net.sf.ehcache.config.CacheConfiguration
Accessor
isDiskPersistent() - Method in class net.sf.ehcache.management.CacheConfiguration
Accessor
isDiskPersistent() - Method in interface net.sf.ehcache.management.CacheConfigurationMBean
Accessor
isDiskStore() - Method in class net.sf.ehcache.Cache
Whether this cache uses a disk store
isDistributed(Ehcache) - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerListener
Determine if the given cache is distributed.
isElementInMemory(Serializable) - Method in class net.sf.ehcache.Cache
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.Cache
Whether an Element is stored in the cache in Memory, indicating a very low cost of retrieval.
isElementInMemory(Serializable) - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
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.blocking.BlockingCache
Whether an Element is stored in the cache in Memory, indicating a very low cost of retrieval.
isElementInMemory(Serializable) - Method in interface net.sf.ehcache.Ehcache
Whether an Element is stored in the cache in Memory, indicating a very low cost of retrieval.
isElementInMemory(Object) - Method in interface net.sf.ehcache.Ehcache
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.Cache
Whether an Element is stored in the cache on Disk, indicating a higher cost of retrieval.
isElementOnDisk(Object) - Method in class net.sf.ehcache.Cache
Whether an Element is stored in the cache on Disk, indicating a higher cost of retrieval.
isElementOnDisk(Serializable) - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
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.blocking.BlockingCache
Whether an Element is stored in the cache on Disk, indicating a higher cost of retrieval.
isElementOnDisk(Serializable) - Method in interface net.sf.ehcache.Ehcache
Whether an Element is stored in the cache on Disk, indicating a higher cost of retrieval.
isElementOnDisk(Object) - Method in interface net.sf.ehcache.Ehcache
Whether an Element is stored in the cache on Disk, indicating a higher cost of retrieval.
isEternal() - Method in class net.sf.ehcache.config.CacheConfiguration
Accessor
isEternal() - Method in class net.sf.ehcache.Element
 
isEternal() - Method in class net.sf.ehcache.management.CacheConfiguration
Accessor
isEternal() - Method in interface net.sf.ehcache.management.CacheConfigurationMBean
Accessor
isExpired(Element) - Method in class net.sf.ehcache.Cache
Checks whether this cache element has expired.
isExpired(Element) - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Checks whether this cache element has expired.
isExpired(Element) - Method in interface net.sf.ehcache.Ehcache
Checks whether this cache element has expired.
isExpired() - Method in class net.sf.ehcache.Element
An element is expired if the expiration time as given by Element.getExpirationTime() is in the past.
isFull() - Method in class net.sf.ehcache.store.LruMemoryStore
An algorithm to tell if the MemoryStore is at or beyond its carrying capacity.
isFull() - Method in class net.sf.ehcache.store.MemoryStore
An algorithm to tell if the MemoryStore is at or beyond its carrying capacity.
isKeyInCache(Object) - Method in class net.sf.ehcache.Cache
An inexpensive check to see if the key exists in the cache.
isKeyInCache(Object) - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
An inexpensive check to see if the key exists in the cache.
isKeyInCache(Object) - Method in interface net.sf.ehcache.Ehcache
An inexpensive check to see if the key exists in the cache.
isKeySerializable() - Method in class net.sf.ehcache.Element
Whether the element's key may be Serialized.
isLifespanSet() - Method in class net.sf.ehcache.Element
Whether any combination of eternal, TTL or TTI has been set.
isMinimalPutsEnabledByDefault() - Method in class net.sf.ehcache.hibernate.EhCacheProvider
Not sure what this is supposed to do.
isMinimalPutsEnabledByDefault() - Method in class net.sf.ehcache.hibernate.SingletonEhCacheProvider
Not sure what this is supposed to do.
isOverflowToDisk() - Method in class net.sf.ehcache.config.CacheConfiguration
Accessor
isOverflowToDisk() - Method in class net.sf.ehcache.management.CacheConfiguration
Accessor
isOverflowToDisk() - Method in interface net.sf.ehcache.management.CacheConfigurationMBean
Accessor
isReplicateUpdatesViaCopy() - Method in interface net.sf.ehcache.distribution.CacheReplicator
Returns whether update is through copy or invalidate
isReplicateUpdatesViaCopy() - Method in class net.sf.ehcache.distribution.RMISynchronousCacheReplicator
 
isSerializable() - Method in class net.sf.ehcache.Element
Whether the element may be Serialized.
isSpoolThreadAlive() - Method in class net.sf.ehcache.store.DiskStore
The spool thread is started when the disk store is created.
isValid() - Method in class net.sf.ehcache.distribution.EventMessage
 
isValueInCache(Object) - Method in class net.sf.ehcache.Cache
An extremely expensive check to see if the value exists in the cache.
isValueInCache(Object) - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
An extremely expensive check to see if the value exists in the cache.
isValueInCache(Object) - Method in interface net.sf.ehcache.Ehcache
An extremely expensive check to see if the value exists in the cache.

L

leastHit(DiskStore.DiskElement[], DiskStore.DiskElement) - Static method in class net.sf.ehcache.store.DiskStore
Finds the least hit of the sampled elements provided
LFU - Static variable in class net.sf.ehcache.store.MemoryStoreEvictionPolicy
LFU - least frequently used.
LfuPolicy - Class in net.sf.ehcache.store
Contains common LFU policy code for use between the LfuMemoryStore and the DiskStore, which also uses an LfuPolicy for evictions.
LfuPolicy() - Constructor for class net.sf.ehcache.store.LfuPolicy
 
listBoundRMICachePeers() - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerListener
Returns a list of bound objects.
listRemoteCachePeers(Ehcache) - Method in interface net.sf.ehcache.distribution.CacheManagerPeerProvider
 
listRemoteCachePeers(Ehcache) - Method in class net.sf.ehcache.distribution.ManualRMICacheManagerPeerProvider
 
listRemoteCachePeers(Ehcache) - Method in class net.sf.ehcache.distribution.MulticastRMICacheManagerPeerProvider
 
listRemoteCachePeers(Ehcache) - Method in class net.sf.ehcache.distribution.RMIBootstrapCacheLoader
Package protected List of cache peers
listRemoteCachePeers(Ehcache) - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerProvider
 
liveness() - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Synchronized version of getName to test liveness of the object lock.
load(Ehcache) - Method in interface net.sf.ehcache.bootstrap.BootstrapCacheLoader
Instructs the loader to load the given cache
load(Object) - Method in class net.sf.ehcache.Cache
The load method provides a means to "pre load" the cache.
load(Object) - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
This method is not appropriate to use with BlockingCache.
load(Ehcache) - Method in class net.sf.ehcache.distribution.RMIBootstrapCacheLoader
Bootstraps the cache from a random CachePeer.
load(Object) - Method in interface net.sf.ehcache.Ehcache
The load method provides a means to "pre load" the cache.
load(Object) - Method in interface net.sf.ehcache.loader.CacheLoader
loads an object.
load(Object, Object) - Method in interface net.sf.ehcache.loader.CacheLoader
Load using both a key and an argument.
loadAll(Collection, Object) - Method in class net.sf.ehcache.Cache
The loadAll method provides a means to "pre load" objects into the cache.
loadAll(Collection, Object) - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
This method is not appropriate to use with BlockingCache.
loadAll(Collection, Object) - Method in interface net.sf.ehcache.Ehcache
The loadAll method provides a means to "pre load" objects into the cache.
loadAll(Collection) - Method in interface net.sf.ehcache.loader.CacheLoader
loads multiple object.
loadAll(Collection, Object) - Method in interface net.sf.ehcache.loader.CacheLoader
Load using both a key and an argument.
lock(Object) - Method in class net.sf.ehcache.hibernate.EhCache
Calls to this method should perform their own synchronization.
LockTimeoutException - Exception in net.sf.ehcache.constructs.blocking
Indicates that a timeout has occured while attempting to obtain a lock using Mutex.attempt(long)

This is a normal runtime exception which should be handled by calling code.

LockTimeoutException() - Constructor for exception net.sf.ehcache.constructs.blocking.LockTimeoutException
Constructs a new runtime exception with null as its detail message.
LockTimeoutException(String) - Constructor for exception net.sf.ehcache.constructs.blocking.LockTimeoutException
Constructs a new runtime exception with the specified detail message.
LockTimeoutException(String, Throwable) - Constructor for exception net.sf.ehcache.constructs.blocking.LockTimeoutException
Constructor for the LockTimeoutException object.
lookupPeer(String) - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerListener
Returns a reference to the remote object.
lookupRemoteCachePeer(String) - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerProvider
The use of one-time registry creation and Naming.rebind should mean we can create as many listeneres as we like.
LRU - Static variable in class net.sf.ehcache.store.MemoryStoreEvictionPolicy
LRU - least recently used.
LruMemoryStore - Class in net.sf.ehcache.store
An implementation of a LruMemoryStore.
LruMemoryStore(Ehcache, Store) - Constructor for class net.sf.ehcache.store.LruMemoryStore
Constructor for the LruMemoryStore object The backing LinkedHashMap is created with LRU by access order.
LruMemoryStore.SpoolingLinkedHashMap - Class in net.sf.ehcache.store
An extension of LinkedHashMap which overrides LruMemoryStore.SpoolingLinkedHashMap.removeEldestEntry(java.util.Map.Entry) to persist cache entries to the auxiliary cache before they are removed.
LruMemoryStore.SpoolingLinkedHashMap() - Constructor for class net.sf.ehcache.store.LruMemoryStore.SpoolingLinkedHashMap
Default constructor.
LruPolicy - Class in net.sf.ehcache.store
Contains common LFU policy code for use between the LfuMemoryStore and the DiskStore, which also uses an LfuPolicy for evictions.
LruPolicy() - Constructor for class net.sf.ehcache.store.LruPolicy
 

M

ManagementService - Class in net.sf.ehcache.management
Ehcache CacheManagers and Caches have lifecycles.
ManagementService(CacheManager, MBeanServer, boolean, boolean, boolean, boolean) - Constructor for class net.sf.ehcache.management.ManagementService
A constructor for a management service for a range of possible MBeans.
ManualRMICacheManagerPeerProvider - Class in net.sf.ehcache.distribution
A provider of Peer RMI addresses based off manual configuration.
ManualRMICacheManagerPeerProvider() - Constructor for class net.sf.ehcache.distribution.ManualRMICacheManagerPeerProvider
Empty constructor.
map - Variable in class net.sf.ehcache.store.LruMemoryStore
Map where items are stored by key.
map - Variable in class net.sf.ehcache.store.MemoryStore
Map where items are stored by key.
maxElementsInMemory - Variable in class net.sf.ehcache.config.CacheConfiguration
the maximum objects to be held in the MemoryStore.
maxElementsOnDisk - Variable in class net.sf.ehcache.config.CacheConfiguration
the maximum objects to be held in the DiskStore.
MAXIMUM_CHUNK_SIZE_BYTES - Static variable in class net.sf.ehcache.distribution.RMIBootstrapCacheLoaderFactory
The property name expected in ehcache.xml for the maximum chunk size in bytes
maximumChunkSizeBytes - Variable in class net.sf.ehcache.distribution.RMIBootstrapCacheLoader
The maximum serialized size of the elements to request from a remote cache peer during bootstrap.
maximumSize - Variable in class net.sf.ehcache.store.LruMemoryStore
The maximum size of the store
maximumSize - Variable in class net.sf.ehcache.store.MemoryStore
The maximum size of the store
MemoryEfficientByteArrayOutputStream - Class in net.sf.ehcache.util
This class is designed to minimise the number of System.arraycopy(); methods required to complete.
MemoryEfficientByteArrayOutputStream(int) - Constructor for class net.sf.ehcache.util.MemoryEfficientByteArrayOutputStream
Creates a new byte array output stream, with a buffer capacity of the specified size, in bytes.
MemoryStore - Class in net.sf.ehcache.store
A Store implementation suitable for fast, concurrent in memory stores.
MemoryStore(Ehcache, Store) - Constructor for class net.sf.ehcache.store.MemoryStore
Constructs things that all MemoryStores have in common.
memoryStoreEvictionPolicy - Variable in class net.sf.ehcache.config.CacheConfiguration
The policy used to evict elements from the MemoryStore.
MemoryStoreEvictionPolicy - Class in net.sf.ehcache.store
A typesafe enumeration of eviction policies.
MESSAGE_CACHE - Static variable in class net.sf.ehcache.constructs.asynchronous.AsynchronousCommandExecutor
The name of the message cache in the ehcache.xml configuration file.
MimeTypeByteArray - Class in net.sf.ehcache
A bean used to wrap byte[] values to be placed in an Element so as to preserve MIME type information.
MimeTypeByteArray() - Constructor for class net.sf.ehcache.MimeTypeByteArray
Empty constructor, as required for JavaBeans
MimeTypeByteArray(String, byte[]) - Constructor for class net.sf.ehcache.MimeTypeByteArray
Full constructor
MINIMUM_SAFE_DISPATCHER_THREAD_INTERVAL - Static variable in class net.sf.ehcache.constructs.asynchronous.AsynchronousCommandExecutor
Minimum setting for the dispatcher thread interval.
MulticastKeepaliveHeartbeatReceiver - Class in net.sf.ehcache.distribution
Receives heartbeats from any MulticastKeepaliveHeartbeatSenders out there.
MulticastKeepaliveHeartbeatReceiver(MulticastRMICacheManagerPeerProvider, InetAddress, Integer) - Constructor for class net.sf.ehcache.distribution.MulticastKeepaliveHeartbeatReceiver
Constructor.
MulticastKeepaliveHeartbeatSender - Class in net.sf.ehcache.distribution
Sends heartbeats to a multicast group containing a compressed list of URLs.
MulticastKeepaliveHeartbeatSender(CacheManager, InetAddress, Integer, Integer) - Constructor for class net.sf.ehcache.distribution.MulticastKeepaliveHeartbeatSender
Constructor.
MulticastRMICacheManagerPeerProvider - Class in net.sf.ehcache.distribution
A peer provider which discovers peers using Multicast.
MulticastRMICacheManagerPeerProvider(CacheManager, InetAddress, Integer, Integer) - Constructor for class net.sf.ehcache.distribution.MulticastRMICacheManagerPeerProvider
Creates and starts a multicast peer provider
MulticastRMICacheManagerPeerProvider.CachePeerEntry - Class in net.sf.ehcache.distribution
Entry containing a looked up CachePeer and date
MulticastRMICacheManagerPeerProvider.CachePeerEntry(CachePeer, Date) - Constructor for class net.sf.ehcache.distribution.MulticastRMICacheManagerPeerProvider.CachePeerEntry
Constructor
Mutex - Class in net.sf.ehcache.concurrent
 
Mutex() - Constructor for class net.sf.ehcache.concurrent.Mutex
 
mutexes - Variable in class net.sf.ehcache.concurrent.StripedMutex
The array of mutexes

N

name - Variable in class net.sf.ehcache.CacheManager
A name for this CacheManager to distinguish it from others.
name - Variable in class net.sf.ehcache.config.CacheConfiguration
the name of the cache.
net.sf.ehcache - package net.sf.ehcache
This package contains the public API for using ehcache.
net.sf.ehcache.bootstrap - package net.sf.ehcache.bootstrap
This package contains the bootstrap cache loader interface and abstract factory.
net.sf.ehcache.concurrent - package net.sf.ehcache.concurrent
This package contains concurrency classes and utilities that are not available in java.util.concurrent.
net.sf.ehcache.config - package net.sf.ehcache.config
This package contains the cache configuration code.
net.sf.ehcache.constructs.asynchronous - package net.sf.ehcache.constructs.asynchronous
 
net.sf.ehcache.constructs.blocking - package net.sf.ehcache.constructs.blocking
Doug Lea in his book Concurrent Programming in Java talks about concurrency support constructs.
net.sf.ehcache.distribution - package net.sf.ehcache.distribution
This package is for cache replication.
net.sf.ehcache.event - package net.sf.ehcache.event
This package contains interfaces and classes for listening to events.
net.sf.ehcache.exceptionhandler - package net.sf.ehcache.exceptionhandler
This package is for exception handling.
net.sf.ehcache.extension - package net.sf.ehcache.extension
This package contains interfaces and classes for the cache extension mechanism.
net.sf.ehcache.hibernate - package net.sf.ehcache.hibernate
This package contains interfaces and classes for Hibernate3.1 and higher.
net.sf.ehcache.loader - package net.sf.ehcache.loader
This package contains a cache loaders and associated factories.
net.sf.ehcache.management - package net.sf.ehcache.management
This package contains JMX MBeans and implementations for management of ehcache.
net.sf.ehcache.store - package net.sf.ehcache.store
Store package.
net.sf.ehcache.util - package net.sf.ehcache.util
Util package.
NET_SF_EHCACHE_CONFIGURATION_RESOURCE_NAME - Static variable in class net.sf.ehcache.hibernate.EhCacheProvider
The Hibernate system property specifying the location of the ehcache configuration file name.
NET_SF_EHCACHE_CONFIGURATION_RESOURCE_NAME - Static variable in class net.sf.ehcache.hibernate.SingletonEhCacheProvider
The Hibernate system property specifying the location of the ehcache configuration file name.
NET_SF_EHCACHE_DISABLED - Static variable in class net.sf.ehcache.Cache
System Property based method of disabling ehcache.
NET_SF_EHCACHE_USE_CLASSIC_LRU - Static variable in class net.sf.ehcache.Cache
System Property based method of selecting the LruMemoryStore in use up to ehcache 1.5.
nextTimestamp() - Method in class net.sf.ehcache.hibernate.EhCache
Gets the next timestamp;
nextTimestamp() - Method in class net.sf.ehcache.hibernate.EhCacheProvider
Returns the next timestamp.
nextTimestamp() - Method in class net.sf.ehcache.hibernate.SingletonEhCacheProvider
Returns the next timestamp.
notAlive() - Method in interface net.sf.ehcache.distribution.CacheReplicator
Returns whether the replicator is not active.
notAlive() - Method in class net.sf.ehcache.distribution.RMISynchronousCacheReplicator
Asserts that the replicator is active.
notifyCacheAdded(String) - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerListener
Called immediately after a cache has been added and activated.
notifyCacheAdded(String) - Method in interface net.sf.ehcache.event.CacheManagerEventListener
Called immediately after a cache has been added and activated.
notifyCacheAdded(String) - Method in class net.sf.ehcache.event.CacheManagerEventListenerRegistry
Called immediately after a cache has been added and activated.
notifyCacheAdded(String) - Method in class net.sf.ehcache.management.ManagementService
Called immediately after a cache has been added and activated.
notifyCacheRemoved(String) - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerListener
Called immediately after a cache has been disposed and removed.
notifyCacheRemoved(String) - Method in interface net.sf.ehcache.event.CacheManagerEventListener
Called immediately after a cache has been disposed and removed.
notifyCacheRemoved(String) - Method in class net.sf.ehcache.event.CacheManagerEventListenerRegistry
Called immediately after a cache has been disposed and removed.
notifyCacheRemoved(String) - Method in class net.sf.ehcache.management.ManagementService
Called immediately after a cache has been disposed and removed.
notifyElementEvicted(Ehcache, Element) - Method in class net.sf.ehcache.distribution.RMISynchronousCacheReplicator
Called immediately after an element is evicted from the cache.
notifyElementEvicted(Ehcache, Element) - Method in interface net.sf.ehcache.event.CacheEventListener
Called immediately after an element is evicted from the cache.
notifyElementEvicted(Element, boolean) - Method in class net.sf.ehcache.event.RegisteredEventListeners
Notifies all registered listeners, in no guaranteed order, that an element has been evicted from the cache
notifyElementExpired(Ehcache, Element) - Method in class net.sf.ehcache.distribution.RMISynchronousCacheReplicator
Called immediately after an element is found to be expired.
notifyElementExpired(Ehcache, Element) - Method in interface net.sf.ehcache.event.CacheEventListener
Called immediately after an element is found to be expired.
notifyElementExpiry(Element, boolean) - Method in class net.sf.ehcache.event.RegisteredEventListeners
Notifies all registered listeners, in no guaranteed order, that an element has expired
notifyElementPut(Ehcache, Element) - Method in class net.sf.ehcache.distribution.RMIAsynchronousCacheReplicator
Called immediately after an element has been put into the cache.
notifyElementPut(Ehcache, Element) - Method in class net.sf.ehcache.distribution.RMISynchronousCacheReplicator
Called immediately after an element has been put into the cache.
notifyElementPut(Ehcache, Element) - Method in interface net.sf.ehcache.event.CacheEventListener
Called immediately after an element has been put into the cache.
notifyElementPut(Element, boolean) - Method in class net.sf.ehcache.event.RegisteredEventListeners
Notifies all registered listeners, in no guaranteed order, that an element was put into the cache
notifyElementRemoved(Ehcache, Element) - Method in class net.sf.ehcache.distribution.RMIAsynchronousCacheReplicator
Called immediately after an attempt to remove an element.
notifyElementRemoved(Ehcache, Element) - Method in class net.sf.ehcache.distribution.RMISynchronousCacheReplicator
Called immediately after an attempt to remove an element.
notifyElementRemoved(Ehcache, Element) - Method in interface net.sf.ehcache.event.CacheEventListener
Called immediately after an attempt to remove an element.
notifyElementRemoved(Element, boolean) - Method in class net.sf.ehcache.event.RegisteredEventListeners
Notifies all registered listeners, in no guaranteed order, that an element was removed
notifyElementUpdated(Ehcache, Element) - Method in class net.sf.ehcache.distribution.RMIAsynchronousCacheReplicator
Called immediately after an element has been put into the cache and the element already existed in the cache.
notifyElementUpdated(Ehcache, Element) - Method in class net.sf.ehcache.distribution.RMISynchronousCacheReplicator
Called immediately after an element has been put into the cache and the element already existed in the cache.
notifyElementUpdated(Ehcache, Element) - Method in interface net.sf.ehcache.event.CacheEventListener
Called immediately after an element has been put into the cache and the element already existed in the cache.
notifyElementUpdated(Element, boolean) - Method in class net.sf.ehcache.event.RegisteredEventListeners
Notifies all registered listeners, in no guaranteed order, that an element in the cache was updated
notifyExpiry(Element) - Method in class net.sf.ehcache.store.LruMemoryStore
Before eviction elements are checked.
notifyExpiry(Element) - Method in class net.sf.ehcache.store.MemoryStore
Before eviction elements are checked.
notifyRemoveAll(Ehcache) - Method in class net.sf.ehcache.distribution.RMIAsynchronousCacheReplicator
Called during Ehcache.removeAll() to indicate that the all elements have been removed from the cache in a bulk operation.
notifyRemoveAll(Ehcache) - Method in class net.sf.ehcache.distribution.RMISynchronousCacheReplicator
Called during Ehcache.removeAll() to indicate that the all elements have been removed from the cache in a bulk operation.
notifyRemoveAll(Ehcache) - Method in interface net.sf.ehcache.event.CacheEventListener
Called during Ehcache.removeAll() to indicate that the all elements have been removed from the cache in a bulk operation.
notifyRemoveAll(boolean) - Method in class net.sf.ehcache.event.RegisteredEventListeners
Notifies all registered listeners, in no guaranteed order, that removeAll has been called and all elements cleared
numberOfCachesThatAreDiskPersistent() - Method in class net.sf.ehcache.config.ConfigurationHelper
Calculates the number of caches in the configuration that are diskPersistent
numberOfCachesThatOverflowToDisk() - Method in class net.sf.ehcache.config.ConfigurationHelper
Calculates the number of caches in the configuration that overflow to disk

O

ObjectExistsException - Exception in net.sf.ehcache
Thrown when a duplicate cache is attemtpted to be created
ObjectExistsException() - Constructor for exception net.sf.ehcache.ObjectExistsException
Constructor for the ObjectExistsException object.
ObjectExistsException(String) - Constructor for exception net.sf.ehcache.ObjectExistsException
Constructor for the ObjectExistsException object.
ONE_CENTURY - Static variable in interface net.sf.ehcache.concurrent.Sync
One century in milliseconds; convenient as a time-out value
ONE_DAY - Static variable in interface net.sf.ehcache.concurrent.Sync
One day, in milliseconds; convenient as a time-out value *
ONE_HOUR - Static variable in interface net.sf.ehcache.concurrent.Sync
One hour, in milliseconds; convenient as a time-out value *
ONE_HUNDRED_MB - Static variable in class net.sf.ehcache.distribution.RMIBootstrapCacheLoaderFactory
The highest reasonable chunk size in bytes
ONE_MINUTE - Static variable in interface net.sf.ehcache.concurrent.Sync
One minute, in milliseconds; convenient as a time-out value *
ONE_SECOND - Static variable in interface net.sf.ehcache.concurrent.Sync
One second, in milliseconds; convenient as a time-out value *
ONE_WEEK - Static variable in interface net.sf.ehcache.concurrent.Sync
One week, in milliseconds; convenient as a time-out value *
ONE_YEAR - Static variable in interface net.sf.ehcache.concurrent.Sync
One year in milliseconds; convenient as a time-out value Not that it matters, but there is some variation across standard sources about value at msec precision.
onException(Ehcache, Object, Exception) - Method in interface net.sf.ehcache.exceptionhandler.CacheExceptionHandler
Called if an Exception occurs in a Cache method.
overflowToDisk - Variable in class net.sf.ehcache.config.CacheConfiguration
whether elements can overflow to disk when the in-memory cache has reached the set limit.

P

parseBoolean(String) - Static method in class net.sf.ehcache.util.PropertyUtil
Null safe, parser of boolean from a String
parseConfiguration(File) - Static method in class net.sf.ehcache.config.ConfigurationFactory
Configures a bean from an XML file.
parseConfiguration(URL) - Static method in class net.sf.ehcache.config.ConfigurationFactory
Configures a bean from an XML file available as an URL.
parseConfiguration() - Static method in class net.sf.ehcache.config.ConfigurationFactory
Configures a bean from an XML file in the classpath.
parseConfiguration(InputStream) - Static method in class net.sf.ehcache.config.ConfigurationFactory
Configures a bean from an XML input stream.
parseProperties(String, String) - Static method in class net.sf.ehcache.util.PropertyUtil
Parse properties supplied as a comma separated list into a Properties object
peerUrls - Variable in class net.sf.ehcache.distribution.RMICacheManagerPeerProvider
Contains a RMI URLs of the form: "//" + hostName + ":" + port + "/" + cacheName;
policy - Variable in class net.sf.ehcache.store.MemoryStore
The eviction policy to use
Policy - Interface in net.sf.ehcache.store
An eviction policy.
populateListOfRemoteCachePeers() - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerListener
Should be called on init because this is one of the last things that should happen on CacheManager startup.
port - Variable in class net.sf.ehcache.distribution.RMICacheManagerPeerListener
The RMI listener port
properties - Variable in class net.sf.ehcache.config.FactoryConfiguration
properties.
propertySeparator - Variable in class net.sf.ehcache.config.FactoryConfiguration
A property separator.
PropertyUtil - Class in net.sf.ehcache.util
Property utilities.
put(Element) - Method in class net.sf.ehcache.Cache
Put an element in the cache.
put(Element, boolean) - Method in class net.sf.ehcache.Cache
Put an element in the cache.
put(Element) - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Adds an entry and unlocks it
put(Element, boolean) - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Put an element in the cache.
put(Element) - Method in interface net.sf.ehcache.distribution.CachePeer
Put an element in the cache.
PUT - Static variable in class net.sf.ehcache.distribution.EventMessage
A put or update event.
put(Element) - Method in class net.sf.ehcache.distribution.RMICachePeer
Puts an Element into the underlying cache without notifying listeners or updating statistics.
put(Element) - Method in interface net.sf.ehcache.Ehcache
Put an element in the cache.
put(Element, boolean) - Method in interface net.sf.ehcache.Ehcache
Put an element in the cache.
put(Object, Object) - Method in class net.sf.ehcache.hibernate.EhCache
Puts an object into the cache.
put(Element) - Method in class net.sf.ehcache.store.DiskStore
Puts an element into the disk store.
put(Element) - Method in class net.sf.ehcache.store.LruMemoryStore
Puts an item in the cache.
put(Element) - Method in class net.sf.ehcache.store.MemoryStore
Puts an item in the store.
put(Element) - Method in interface net.sf.ehcache.store.Store
Puts an item into the store.
putQuiet(Element) - Method in class net.sf.ehcache.Cache
Put an element in the cache, without updating statistics, or updating listeners.
putQuiet(Element) - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Put an element in the cache, without updating statistics, or updating listeners.
putQuiet(Element) - Method in interface net.sf.ehcache.Ehcache
Put an element in the cache, without updating statistics, or updating listeners.

Q

QUEUE_KEY - Static variable in class net.sf.ehcache.constructs.asynchronous.AsynchronousCommandExecutor
The messageCache contains Command element values, and a queue that maintains their order.
queueForExecution(Command) - Method in class net.sf.ehcache.constructs.asynchronous.AsynchronousCommandExecutor
Stores parameters in the AsynchronousCommandExecutor.MESSAGE_CACHE for later execution.

R

read(Object) - Method in class net.sf.ehcache.hibernate.EhCache
Gets an object from the cache.
refresh() - Method in class net.sf.ehcache.constructs.blocking.SelfPopulatingCache
Refresh the elements of this cache.
refresh() - Method in class net.sf.ehcache.constructs.blocking.UpdatingSelfPopulatingCache
This method should not be used.
refreshElement(Element, Ehcache) - Method in class net.sf.ehcache.constructs.blocking.SelfPopulatingCache
Refresh a single element.
registerCacheExtension(CacheExtension) - Method in class net.sf.ehcache.Cache
Register a CacheExtension with the cache.
registerCacheExtension(CacheExtension) - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Register a CacheExtension with the cache.
registerCacheExtension(CacheExtension) - Method in interface net.sf.ehcache.Ehcache
Register a CacheExtension with the cache.
registerCacheExtensions(CacheConfiguration, Ehcache) - Static method in class net.sf.ehcache.config.ConfigurationHelper
A factory method to register cache extensions
registerCacheListeners(CacheConfiguration, RegisteredEventListeners) - Static method in class net.sf.ehcache.config.ConfigurationHelper
A factory method to create a RegisteredEventListeners
registerCacheLoader(CacheLoader) - Method in class net.sf.ehcache.Cache
Register a CacheLoader with the cache.
registerCacheLoader(CacheLoader) - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Register a CacheLoader with the cache.
registerCacheLoader(CacheLoader) - Method in interface net.sf.ehcache.Ehcache
Register a CacheLoader with the cache.
registerCacheLoaders(CacheConfiguration, Ehcache) - Static method in class net.sf.ehcache.config.ConfigurationHelper
A factory method to register cache Loaders
RegisteredEventListeners - Class in net.sf.ehcache.event
Registered listeners for registering and unregistering CacheEventListeners and multicasting notifications to registrants.
RegisteredEventListeners(Ehcache) - Constructor for class net.sf.ehcache.event.RegisteredEventListeners
Constructs a new notification service
registerListener(CacheManagerEventListener) - Method in class net.sf.ehcache.event.CacheManagerEventListenerRegistry
Adds a listener to the notification service.
registerListener(CacheEventListener) - Method in class net.sf.ehcache.event.RegisteredEventListeners
Adds a listener to the notification service.
registerMBeans(CacheManager, MBeanServer, boolean, boolean, boolean, boolean) - Static method in class net.sf.ehcache.management.ManagementService
A convenience static method which creates a ManagementService and initialises it with the supplied parameters.
registerPeer(String) - Method in interface net.sf.ehcache.distribution.CacheManagerPeerProvider
Register a new peer.
registerPeer(String) - Method in class net.sf.ehcache.distribution.ManualRMICacheManagerPeerProvider
Register a new peer.
registerPeer(String) - Method in class net.sf.ehcache.distribution.MulticastRMICacheManagerPeerProvider
Register a new peer, but only if the peer is new, otherwise the last seen timestamp is updated.
registerPeer(String) - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerProvider
Register a new peer
release() - Method in class net.sf.ehcache.concurrent.Mutex
Potentially enable others to pass.
release() - Method in interface net.sf.ehcache.concurrent.Sync
Potentially enable others to pass.
RemoteCacheException - Exception in net.sf.ehcache.distribution
A Cache Exception in the distribution mechanism.
RemoteCacheException() - Constructor for exception net.sf.ehcache.distribution.RemoteCacheException
Constructor for the RemoteCacheException object.
RemoteCacheException(String) - Constructor for exception net.sf.ehcache.distribution.RemoteCacheException
Constructor for the RemoteCacheException object.
RemoteCacheException(String, Throwable) - Constructor for exception net.sf.ehcache.distribution.RemoteCacheException
Constructor for the RemoteCacheException object.
removalAll() - Method in class net.sf.ehcache.CacheManager
Removes all caches using CacheManager.removeCache(java.lang.String) for each cache.
remove(Serializable) - Method in class net.sf.ehcache.Cache
Removes an Element from the Cache.
remove(Object) - Method in class net.sf.ehcache.Cache
Removes an Element from the Cache.
remove(Serializable, boolean) - Method in class net.sf.ehcache.Cache
Removes an Element from the Cache.
remove(Object, boolean) - Method in class net.sf.ehcache.Cache
Removes an Element from the Cache.
remove(Serializable) - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Removes an Element from the Cache.
remove(Object) - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Removes an Element from the Cache.
remove(Serializable, boolean) - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Removes an Element from the Cache.
remove(Object, boolean) - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Removes an Element from the Cache.
remove(Serializable) - Method in interface net.sf.ehcache.distribution.CachePeer
Removes an Element from the Cache.
REMOVE - Static variable in class net.sf.ehcache.distribution.EventMessage
A remove or invalidate event.
remove(Serializable) - Method in class net.sf.ehcache.distribution.RMICachePeer
Removes an Element from the underlying cache without notifying listeners or updating statistics.
remove(Serializable) - Method in interface net.sf.ehcache.Ehcache
Removes an Element from the Cache.
remove(Object) - Method in interface net.sf.ehcache.Ehcache
Removes an Element from the Cache.
remove(Serializable, boolean) - Method in interface net.sf.ehcache.Ehcache
Removes an Element from the Cache.
remove(Object, boolean) - Method in interface net.sf.ehcache.Ehcache
Removes an Element from the Cache.
remove(Object) - Method in class net.sf.ehcache.hibernate.EhCache
Removes the element which matches the key.
remove(Object) - Method in class net.sf.ehcache.store.DiskStore
Removes an item from the disk store.
remove(Object) - Method in class net.sf.ehcache.store.LruMemoryStore
Removes an Element from the store.
remove(Object) - Method in class net.sf.ehcache.store.MemoryStore
Removes an Element from the store.
remove(Object) - Method in interface net.sf.ehcache.store.Store
Removes an item from the cache.
REMOVE_ALL - Static variable in class net.sf.ehcache.distribution.EventMessage
A removeAll, which removes all elements from a cache
removeAll() - Method in class net.sf.ehcache.Cache
Removes all cached items.
removeAll(boolean) - Method in class net.sf.ehcache.Cache
Removes all cached items.
removeAll() - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Removes all cached items.
removeAll(boolean) - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Removes all cached items.
removeAll() - Method in interface net.sf.ehcache.distribution.CachePeer
Removes all cached items.
removeAll() - Method in class net.sf.ehcache.distribution.RMICachePeer
Removes all cached items.
removeAll() - Method in interface net.sf.ehcache.Ehcache
Removes all cached items.
removeAll(boolean) - Method in interface net.sf.ehcache.Ehcache
Removes all cached items.
removeAll() - Method in class net.sf.ehcache.management.Cache
Removes all cached items.
removeAll() - Method in interface net.sf.ehcache.management.CacheMBean
Removes all cached items.
removeAll() - Method in class net.sf.ehcache.store.DiskStore
Remove all of the elements from the store.
removeAll() - Method in class net.sf.ehcache.store.LruMemoryStore
Remove all of the elements from the store.
removeAll() - Method in class net.sf.ehcache.store.MemoryStore
Remove all of the elements from the store.
removeAll() - Method in interface net.sf.ehcache.store.Store
Remove all of the elements from the store.
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.LruMemoryStore.SpoolingLinkedHashMap
Returns true if this map should remove its eldest entry.
removeElementChosenByEvictionPolicy(Element) - Method in class net.sf.ehcache.store.MemoryStore
Removes the element chosen by the eviction policy
removeQuiet(Serializable) - Method in class net.sf.ehcache.Cache
Removes an Element from the Cache, without notifying listeners.
removeQuiet(Object) - Method in class net.sf.ehcache.Cache
Removes an Element from the Cache, without notifying listeners.
removeQuiet(Serializable) - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Removes an Element from the Cache, without notifying listeners.
removeQuiet(Object) - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Removes an Element from the Cache, without notifying listeners.
removeQuiet(Serializable) - Method in interface net.sf.ehcache.Ehcache
Removes an Element from the Cache, without notifying listeners.
removeQuiet(Object) - Method in interface net.sf.ehcache.Ehcache
Removes an Element from the Cache, without notifying listeners.
replaceCacheWithDecoratedCache(Ehcache, Ehcache) - Method in class net.sf.ehcache.CacheManager
Replaces in the map of Caches managed by this CacheManager an Ehcache with a decorated version of the same Ehcache.
replaceToken(String, String, String) - Static method in class net.sf.ehcache.config.DiskStoreConfiguration
Replaces a token with replacement text.
replicatePutNotification(Ehcache, Element) - Static method in class net.sf.ehcache.distribution.RMISynchronousCacheReplicator
Does the actual RMI remote call.
replicatePuts - Variable in class net.sf.ehcache.distribution.RMISynchronousCacheReplicator
Whether to replicate puts.
replicatePutsViaCopy - Variable in class net.sf.ehcache.distribution.RMISynchronousCacheReplicator
Whether a put should replicated by copy or by invalidation, (a remove).
replicateRemovalNotification(Ehcache, Serializable) - Static method in class net.sf.ehcache.distribution.RMISynchronousCacheReplicator
Does the actual RMI remote call.
replicateRemovals - Variable in class net.sf.ehcache.distribution.RMISynchronousCacheReplicator
Whether to replicate removes
replicateRemoveAllNotification(Ehcache) - Method in class net.sf.ehcache.distribution.RMISynchronousCacheReplicator
Does the actual RMI remote call.
replicateUpdates - Variable in class net.sf.ehcache.distribution.RMISynchronousCacheReplicator
Whether to replicate updates.
replicateUpdatesViaCopy - Variable in class net.sf.ehcache.distribution.RMISynchronousCacheReplicator
Whether an update (a put) should be by copy or by invalidation, (a remove).
replicationQueue - Variable in class net.sf.ehcache.distribution.RMIAsynchronousCacheReplicator
A queue of updates.
replicationThread - Variable in class net.sf.ehcache.distribution.RMIAsynchronousCacheReplicator
A thread which handles replication, so that replication can take place asynchronously and not hold up the cache
resetAccessStatistics() - Method in class net.sf.ehcache.Element
Resets the hit count to 0 and the last access time to 0.
RetryAttemptTooSoonException - Exception in net.sf.ehcache.constructs.asynchronous
Thrown to indicate an attempt to retry execution of the command was made before it is allowed.
RetryAttemptTooSoonException(String) - Constructor for exception net.sf.ehcache.constructs.asynchronous.RetryAttemptTooSoonException
Constructs a new exception with the specified detail message.
RetryAttemptTooSoonException(String, Throwable) - Constructor for exception net.sf.ehcache.constructs.asynchronous.RetryAttemptTooSoonException
Constructs a new exception with the specified detail message and cause.
RMIAsynchronousCacheReplicator - Class in net.sf.ehcache.distribution
Listens to CacheManager and Cache events and propagates those to CachePeer peers of the Cache asynchronously.
RMIAsynchronousCacheReplicator(boolean, boolean, boolean, boolean, boolean, int) - Constructor for class net.sf.ehcache.distribution.RMIAsynchronousCacheReplicator
Constructor for internal and subclass use
RMIBootstrapCacheLoader - Class in net.sf.ehcache.distribution
Loads Elements from a random Cache Peer
RMIBootstrapCacheLoader(boolean, int) - Constructor for class net.sf.ehcache.distribution.RMIBootstrapCacheLoader
Creates a boostrap cache loader that will work with RMI based distribution
RMIBootstrapCacheLoaderFactory - Class in net.sf.ehcache.distribution
A factory to create a configured RMIBootstrapCacheLoader
RMIBootstrapCacheLoaderFactory() - Constructor for class net.sf.ehcache.distribution.RMIBootstrapCacheLoaderFactory
 
RMICacheManagerPeerListener - Class in net.sf.ehcache.distribution
A cache server which exposes available cache operations remotely through RMI.
RMICacheManagerPeerListener(String, Integer, Integer, CacheManager, Integer) - Constructor for class net.sf.ehcache.distribution.RMICacheManagerPeerListener
Constructor with full arguments.
RMICacheManagerPeerListenerFactory - Class in net.sf.ehcache.distribution
Builds a listener based on RMI.
RMICacheManagerPeerListenerFactory() - Constructor for class net.sf.ehcache.distribution.RMICacheManagerPeerListenerFactory
 
RMICacheManagerPeerProvider - Class in net.sf.ehcache.distribution
A provider of Peer RMI addresses.
RMICacheManagerPeerProvider(CacheManager) - Constructor for class net.sf.ehcache.distribution.RMICacheManagerPeerProvider
Constructor
RMICacheManagerPeerProvider() - Constructor for class net.sf.ehcache.distribution.RMICacheManagerPeerProvider
Empty constructor
RMICacheManagerPeerProviderFactory - Class in net.sf.ehcache.distribution
Builds a factory based on RMI
RMICacheManagerPeerProviderFactory() - Constructor for class net.sf.ehcache.distribution.RMICacheManagerPeerProviderFactory
 
RMICachePeer - Class in net.sf.ehcache.distribution
An RMI based implementation of CachePeer.
RMICachePeer(Ehcache, String, Integer, Integer, Integer) - Constructor for class net.sf.ehcache.distribution.RMICachePeer
Construct a new remote peer.
RMICacheReplicatorFactory - Class in net.sf.ehcache.distribution
Creates an RMICacheReplicator using properties.
RMICacheReplicatorFactory() - Constructor for class net.sf.ehcache.distribution.RMICacheReplicatorFactory
 
RMISynchronousCacheReplicator - Class in net.sf.ehcache.distribution
Listens to CacheManager and Cache events and propagates those to CachePeer peers of the Cache.
RMISynchronousCacheReplicator(boolean, boolean, boolean, boolean, boolean) - Constructor for class net.sf.ehcache.distribution.RMISynchronousCacheReplicator
Constructor for internal and subclass use

S

sampleElements(int) - Method in class net.sf.ehcache.store.MemoryStore
Uses random numbers to sample the entire map.
sampleElementsViaKeyArray() - Method in class net.sf.ehcache.store.MemoryStore
Uses random numbers to sample the entire map.
saveKey(Element) - Method in class net.sf.ehcache.store.MemoryStore
Saves the key to our fast access AtomicReferenceArray
selectedBasedOnPolicy(Element[], Element) - Method in class net.sf.ehcache.store.AbstractPolicy
Finds the best eviction candidate based on the sampled elements.
selectedBasedOnPolicy(Element[], Element) - Method in interface net.sf.ehcache.store.Policy
Finds the best eviction candidate based on the sampled elements.
selectLock(Object, int) - Static method in class net.sf.ehcache.concurrent.ConcurrencyUtil
Selects a lock for a key.
SelfPopulatingCache - Class in net.sf.ehcache.constructs.blocking
A selfpopulating decorator for Ehcache that creates entries on demand.
SelfPopulatingCache(Ehcache, CacheEntryFactory) - Constructor for class net.sf.ehcache.constructs.blocking.SelfPopulatingCache
Creates a SelfPopulatingCache.
send(List) - Method in interface net.sf.ehcache.distribution.CachePeer
Send the cache peer with an ordered list of EventMessages.
send(List) - Method in class net.sf.ehcache.distribution.RMICachePeer
Send the cache peer with an ordered list of EventMessages

This enables multiple messages to be delivered in one network invocation.

serialize(Serializable, int) - Static method in class net.sf.ehcache.util.MemoryEfficientByteArrayOutputStream
Factory method
serialize(Serializable) - Static method in class net.sf.ehcache.util.MemoryEfficientByteArrayOutputStream
Factory method.
setBootstrapCacheLoader(BootstrapCacheLoader) - Method in class net.sf.ehcache.Cache
Sets the bootstrap cache loader.
setBootstrapCacheLoader(BootstrapCacheLoader) - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Sets the bootstrap cache loader.
setBootstrapCacheLoader(BootstrapCacheLoader) - Method in interface net.sf.ehcache.Ehcache
Sets the bootstrap cache loader.
setCacheExceptionHandler(CacheExceptionHandler) - Method in class net.sf.ehcache.Cache
Sets an ExceptionHandler on the Cache.
setCacheExceptionHandler(CacheExceptionHandler) - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Sets an ExceptionHandler on the Cache.
setCacheExceptionHandler(CacheExceptionHandler) - Method in interface net.sf.ehcache.Ehcache
Sets an ExceptionHandler on the Cache.
setCacheManager(CacheManager) - Method in class net.sf.ehcache.Cache
For use by CacheManager.
setCacheManager(CacheManager) - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Sets the CacheManager
setCacheManager(CacheManager) - Method in interface net.sf.ehcache.Ehcache
Sets the CacheManager
setCacheManagerEventListener(CacheManagerEventListener) - Method in class net.sf.ehcache.CacheManager
Same as getCacheManagerEventListenerRegistry().registerListener(cacheManagerEventListener); Left for backward compatiblity
setClass(String) - Method in class net.sf.ehcache.config.FactoryConfiguration
Sets the class name.
setClearOnFlush(boolean) - Method in class net.sf.ehcache.config.CacheConfiguration
Sets whether the MemoryStore should be cleared when flush() is called on the cache - true by default.
setCreateTime() - Method in class net.sf.ehcache.Element
Sets the creationTime attribute of the ElementAttributes object.
setDefaultCacheConfiguration(CacheConfiguration) - Method in class net.sf.ehcache.config.Configuration
 
setDisabled(boolean) - Method in class net.sf.ehcache.Cache
Disables or enables this cache.
setDisabled(boolean) - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Disables or enables this cache.
setDisabled(boolean) - Method in interface net.sf.ehcache.Ehcache
Disables or enables this cache.
setDiskExpiryThreadIntervalSeconds(long) - Method in class net.sf.ehcache.config.CacheConfiguration
Sets the interval in seconds between runs of the disk expiry thread.
setDiskPersistent(boolean) - Method in class net.sf.ehcache.config.CacheConfiguration
Sets whether, for caches that overflow to disk, the disk cache persist between CacheManager instances.
setDiskSpoolBufferSizeMB(int) - Method in class net.sf.ehcache.config.CacheConfiguration
Sets the disk spool size
setDiskStorePath(String) - Method in class net.sf.ehcache.Cache
DiskStore paths can conflict between CacheManager instances.
setDiskStorePath(String) - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
DiskStore paths can conflict between CacheManager instances.
setDiskStorePath(String) - Method in interface net.sf.ehcache.Ehcache
DiskStore paths can conflict between CacheManager instances.
setDispatcherThreadIntervalSeconds(long) - Method in class net.sf.ehcache.constructs.asynchronous.AsynchronousCommandExecutor
Sets the interval between runs of the dispatch thread, when no new dispatch invocations have occurred.
setEternal(boolean) - Method in class net.sf.ehcache.config.CacheConfiguration
Sets whether elements are eternal.
setEternal(boolean) - Method in class net.sf.ehcache.Element
Sets whether the element is eternal.
setEvictionPolicy(Policy) - Method in class net.sf.ehcache.store.DiskStore
Sets the eviction policy strategy.
setEvictionPolicy(Policy) - Method in class net.sf.ehcache.store.LruMemoryStore
Sets the eviction policy strategy.
setEvictionPolicy(Policy) - Method in class net.sf.ehcache.store.MemoryStore
Sets the policy.
setEvictionPolicy(Policy) - Method in interface net.sf.ehcache.store.Store
Sets the eviction policy strategy.
setHeartBeatInterval(long) - Static method in class net.sf.ehcache.distribution.MulticastKeepaliveHeartbeatSender
Sets the heartbeat interval to something other than the default of 5000ms.
setMaxElementsInMemory(int) - Method in class net.sf.ehcache.config.CacheConfiguration
Sets the maximum objects to be held in memory.
setMaxElementsOnDisk(int) - Method in class net.sf.ehcache.config.CacheConfiguration
Sets the maximum number elements on Disk.
setMemoryStoreEvictionPolicy(Policy) - Method in class net.sf.ehcache.Cache
Sets the eviction policy strategy.
setMemoryStoreEvictionPolicy(String) - Method in class net.sf.ehcache.config.CacheConfiguration
Sets the eviction policy.
setMemoryStoreEvictionPolicyFromObject(MemoryStoreEvictionPolicy) - Method in class net.sf.ehcache.config.CacheConfiguration
Sets the eviction policy.
setMimeType(String) - Method in class net.sf.ehcache.MimeTypeByteArray
 
setName(String) - Method in class net.sf.ehcache.Cache
Sets the cache name which will name.
setName(String) - Method in class net.sf.ehcache.CacheManager
Sets the name of the CacheManager.
setName(String) - Method in class net.sf.ehcache.config.CacheConfiguration
Sets the name of the cache.
setName(String) - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Sets the cache name which will name.
setName(String) - Method in interface net.sf.ehcache.Ehcache
Sets the cache name which will name.
setOverflowToDisk(boolean) - Method in class net.sf.ehcache.config.CacheConfiguration
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.DiskStoreConfiguration
Translates and sets the path.
setProperties(String) - Method in class net.sf.ehcache.config.FactoryConfiguration
Sets the configuration properties.
setPropertySeparator(String) - Method in class net.sf.ehcache.config.FactoryConfiguration
Setter
setSource(String) - Method in class net.sf.ehcache.config.Configuration
Sets the configuration source.
setStatisticsAccuracy(int) - Method in class net.sf.ehcache.Cache
Sets the statistics accuracy.
setStatisticsAccuracy(int) - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Sets the statistics accuracy.
setStatisticsAccuracy(int) - Method in interface net.sf.ehcache.Ehcache
Sets the statistics accuracy.
setTimeoutMillis(int) - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Sets the time to wait to acquire a lock.
setTimeToIdle(int) - Method in class net.sf.ehcache.Element
Sets time to idle
setTimeToIdleSeconds(long) - Method in class net.sf.ehcache.config.CacheConfiguration
Sets the time to idle for an element before it expires.
setTimeToLive(int) - Method in class net.sf.ehcache.Element
Sets time to Live
setTimeToLiveSeconds(long) - Method in class net.sf.ehcache.config.CacheConfiguration
Sets the time to idle for an element before it expires.
setUnsafeDispatcherThreadIntervalSeconds(long) - Method in class net.sf.ehcache.constructs.asynchronous.AsynchronousCommandExecutor
Sets the interval between runs of the dispatch thread, when no new dispatch invocations have occurred.
setValue(byte[]) - Method in class net.sf.ehcache.MimeTypeByteArray
 
setVersion(long) - Method in class net.sf.ehcache.Element
Sets the version attribute of the ElementAttributes object.
SHORT_DELAY - Static variable in class net.sf.ehcache.distribution.MulticastRMICacheManagerPeerProvider
One tenth of a second, in ms
shutdown() - Method in class net.sf.ehcache.CacheManager
Shuts down the CacheManager.
shutdown() - Method in class net.sf.ehcache.management.CacheManager
Shuts down the CacheManager.
shutdown() - Method in interface net.sf.ehcache.management.CacheManagerMBean
Shuts down the CacheManager.
shutdownHook - Variable in class net.sf.ehcache.CacheManager
The shutdown hook thread for CacheManager.
SingletonEhCacheProvider - Class in net.sf.ehcache.hibernate
Singleton cache Provider plugin for Hibernate 3.2 and ehcache-1.2.
SingletonEhCacheProvider() - Constructor for class net.sf.ehcache.hibernate.SingletonEhCacheProvider
 
spoolAllToDisk() - Method in class net.sf.ehcache.store.LruMemoryStore
Spools all elements to disk, in preparation for shutdown.
spoolAllToDisk() - Method in class net.sf.ehcache.store.MemoryStore
Spools all elements to disk, in preparation for shutdown.
spoolToDisk(Element) - Method in class net.sf.ehcache.store.LruMemoryStore
Puts the element in the DiskStore.
spoolToDisk(Element) - Method in class net.sf.ehcache.store.MemoryStore
Puts the element in the DiskStore.
stale(Date) - Method in class net.sf.ehcache.distribution.ManualRMICacheManagerPeerProvider
Whether the entry should be considered stale.
stale(Date) - Method in class net.sf.ehcache.distribution.MulticastRMICacheManagerPeerProvider
Whether the entry should be considered stale.
stale(Date) - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerProvider
Whether the entry should be considered stale.
start(Properties) - Method in class net.sf.ehcache.hibernate.EhCacheProvider
Callback to perform any necessary initialization of the underlying cache implementation during SessionFactory construction.
start(Properties) - Method in class net.sf.ehcache.hibernate.SingletonEhCacheProvider
Callback to perform any necessary initialization of the underlying cache implementation during SessionFactory construction.
startRegistry() - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerListener
Start the rmiregistry.
Statistics - Class in net.sf.ehcache
An immutable Cache statistics implementation}

This is like a value object, with the added ability to clear cache statistics on the cache.

Statistics(Ehcache, int, long, long, long, long, long, float, long, long, long) - Constructor for class net.sf.ehcache.Statistics
Creates a new statistics object, associated with a Cache
STATISTICS_ACCURACY_BEST_EFFORT - Static variable in class net.sf.ehcache.Statistics
Best efforts accuracy setting.
STATISTICS_ACCURACY_GUARANTEED - Static variable in class net.sf.ehcache.Statistics
Guaranteed accuracy setting.
STATISTICS_ACCURACY_NONE - Static variable in class net.sf.ehcache.Statistics
Fast but not accurate setting.
status - Variable in class net.sf.ehcache.CacheManager
Status of the Cache Manager
status - Variable in class net.sf.ehcache.distribution.RMICacheManagerPeerListener
status.
status - Variable in class net.sf.ehcache.distribution.RMISynchronousCacheReplicator
The status of the replicator.
Status - Class in net.sf.ehcache
A pre JDK1.5 compatible enum class to indicate the status of a CacheManager or Cache.
status - Variable in class net.sf.ehcache.store.LruMemoryStore
status.
status - Variable in class net.sf.ehcache.store.MemoryStore
status.
STATUS_ALIVE - Static variable in class net.sf.ehcache.Status
The cache is alive.
STATUS_SHUTDOWN - Static variable in class net.sf.ehcache.Status
The cache is shudown.
STATUS_UNINITIALISED - Static variable in class net.sf.ehcache.Status
The cache is uninitialised.
stop() - Method in class net.sf.ehcache.hibernate.EhCacheProvider
Callback to perform any necessary cleanup of the underlying cache implementation during SessionFactory.close().
stop() - Method in class net.sf.ehcache.hibernate.SingletonEhCacheProvider
Callback to perform any necessary cleanup of the underlying cache implementation during SessionFactory.close().
stopRegistry() - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerListener
Stop the rmiregistry if it was started by this class.
Store - Interface in net.sf.ehcache.store
This is the interface for all stores.
StripedMutex - Class in net.sf.ehcache.concurrent
Provides a number of mutexes which allow fine-grained concurrency.
StripedMutex() - Constructor for class net.sf.ehcache.concurrent.StripedMutex
Constructs a striped mutex with the default 2048 stripes.
StripedMutex(int) - Constructor for class net.sf.ehcache.concurrent.StripedMutex
Constructs a striped mutex with the default 2048 stripes.
stripedMutex - Variable in class net.sf.ehcache.constructs.blocking.BlockingCache
locks
SUCCESSFUL_EXECUTION - Static variable in class net.sf.ehcache.constructs.asynchronous.AsynchronousCommandExecutor
The command completed successfully
Sync - Interface in net.sf.ehcache.concurrent
 

T

timeoutMillis - Variable in class net.sf.ehcache.constructs.blocking.BlockingCache
The amount of time to block a thread before a LockTimeoutException is thrown
timeToIdleSeconds - Variable in class net.sf.ehcache.config.CacheConfiguration
the time to idle for an element before it expires.
timeToLiveSeconds - Variable in class net.sf.ehcache.config.CacheConfiguration
Sets the time to idle for an element before it expires.
toMap() - Method in class net.sf.ehcache.hibernate.EhCache
 
TOO_LARGE_TO_EFFICIENTLY_ITERATE - Static variable in class net.sf.ehcache.store.MemoryStore
This number is magic.
TooManyRetriesException - Exception in net.sf.ehcache.constructs.asynchronous
Thrown when a command has unsuccessfully tried to be executed more than its retry limit.
TooManyRetriesException(String) - Constructor for exception net.sf.ehcache.constructs.asynchronous.TooManyRetriesException
Constructs a new exception with the specified detail message.
TooManyRetriesException(String, Throwable) - Constructor for exception net.sf.ehcache.constructs.asynchronous.TooManyRetriesException
Constructs a new exception with the specified detail message and cause.
toString() - Method in class net.sf.ehcache.Cache
Returns a String representation of Cache.
toString() - Method in class net.sf.ehcache.CacheManager
 
toString() - Method in class net.sf.ehcache.distribution.RMICachePeer
Returns a String that represents the value of this object.
toString() - Method in interface net.sf.ehcache.Ehcache
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.event.CacheManagerEventListenerRegistry
Returns a string representation of the object.
toString() - Method in class net.sf.ehcache.event.RegisteredEventListeners
Returns a string representation of the object.
toString() - Method in class net.sf.ehcache.hibernate.EhCache
 
toString() - Method in class net.sf.ehcache.Statistics
Returns a String representation of the Ehcache statistics.
toString() - Method in class net.sf.ehcache.Status
Returns a string representation of the object.
toString() - Method in class net.sf.ehcache.store.DiskStore
Returns a String representation of the DiskStore
toString() - Method in class net.sf.ehcache.store.MemoryStoreEvictionPolicy
 

U

unbind(RMICachePeer) - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerListener
Unbinds an RMICachePeer and unexports it.
unlock(Object) - Method in class net.sf.ehcache.hibernate.EhCache
Calls to this method should perform their own synchronization.
unregisterCacheExtension(CacheExtension) - Method in class net.sf.ehcache.Cache
Unregister a CacheExtension with the cache.
unregisterCacheExtension(CacheExtension) - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Unregister a CacheExtension with the cache.
unregisterCacheExtension(CacheExtension) - Method in interface net.sf.ehcache.Ehcache
Unregister a CacheExtension with the cache.
unregisterCacheLoader(CacheLoader) - Method in class net.sf.ehcache.Cache
Unregister a CacheLoader with the cache.
unregisterCacheLoader(CacheLoader) - Method in class net.sf.ehcache.constructs.blocking.BlockingCache
Unregister a CacheLoader with the cache.
unregisterCacheLoader(CacheLoader) - Method in interface net.sf.ehcache.Ehcache
Unregister a CacheLoader with the cache.
unregisterListener(CacheManagerEventListener) - Method in class net.sf.ehcache.event.CacheManagerEventListenerRegistry
Removes a listener from the notification service.
unregisterListener(CacheEventListener) - Method in class net.sf.ehcache.event.RegisteredEventListeners
Removes a listener from the notification service.
unregisterPeer(String) - Method in interface net.sf.ehcache.distribution.CacheManagerPeerProvider
Unregisters a peer.
unregisterPeer(String) - Method in class net.sf.ehcache.distribution.RMICacheManagerPeerProvider
Unregisters a peer
update(Object) - Method in class net.sf.ehcache.constructs.blocking.UpdatingSelfPopulatingCache
Element can never be null.
update(Object, Object) - Method in class net.sf.ehcache.hibernate.EhCache
Updates an object in the cache, or if it does not exist, inserts it.
updateAccessStatistics() - Method in class net.sf.ehcache.Element
Sets the last access time to now.
updateEntryValue(Object, Object) - Method in interface net.sf.ehcache.constructs.blocking.UpdatingCacheEntryFactory
Perform an incremental update of data within a CacheEntry.
updateUpdateStatistics() - Method in class net.sf.ehcache.Element
Sets the last access time to now.
UpdatingCacheEntryFactory - Interface in net.sf.ehcache.constructs.blocking
A CacheEntryFactory with one additional method, updateEntryValue((Serializable key, Serializable value) which allows the cache entry to updated rather than replaced.
UpdatingSelfPopulatingCache - Class in net.sf.ehcache.constructs.blocking
A Cache backed cache that creates entries on demand.
UpdatingSelfPopulatingCache(Ehcache, UpdatingCacheEntryFactory) - Constructor for class net.sf.ehcache.constructs.blocking.UpdatingSelfPopulatingCache
Creates a SelfPopulatingCache.
useKeySample - Variable in class net.sf.ehcache.store.MemoryStore
when sampling elements, whether to iterate or to use the keySample array for faster random access

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

true