Skip navigation links
A B C D E F G H I L M N O P Q R S T U V W Z 

A

add(ServiceConfiguration<?>) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder
Adds a ServiceConfiguration to the returned builder.
add(Builder<? extends ServiceConfiguration<?>>) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder
Convenience method to add a ServiceConfiguration that is produced by a Builder.
additionalConfigurationsForPool(String, ResourcePool) - Method in interface org.ehcache.spi.service.PersistableResourceService
Enables this service to create additional configurations to enable support of the passed in resource pool in the context of the given alias.
asynchronous() - Method in class org.ehcache.config.builders.CacheEventListenerConfigurationBuilder
Sets the returned builder for asynchronous event processing.

B

batchSize(int) - Method in class org.ehcache.config.builders.WriteBehindConfigurationBuilder.BatchedWriteBehindConfigurationBuilder
Updates the batch size on the returned builder.
build() - Method in interface org.ehcache.config.builders.Builder
Builds the instance
build() - Method in class org.ehcache.config.builders.CacheConfigurationBuilder
 
build() - Method in class org.ehcache.config.builders.CacheEventListenerConfigurationBuilder
Builds the CacheEventListenerConfiguration this builder represents.
build(boolean) - Method in class org.ehcache.config.builders.CacheManagerBuilder
Builds a CacheManager or a subtype of it and initializes it if requested.
build() - Method in class org.ehcache.config.builders.CacheManagerBuilder
Builds a CacheManager or a subtype of it uninitialized.
build() - Method in class org.ehcache.config.builders.PooledExecutionServiceConfigurationBuilder
Builds the PooledExecutionServiceConfiguration
build() - Method in class org.ehcache.config.builders.ResourcePoolsBuilder
Builds the ResourcePools based on this builder's configuration.
build(boolean) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder
Builds the UserManagedCache, initializing it if requested.
build() - Method in class org.ehcache.config.builders.UserManagedCacheBuilder
Builds an unitialized UserManagedCache.
build() - Method in class org.ehcache.config.builders.WriteBehindConfigurationBuilder.BatchedWriteBehindConfigurationBuilder
build() - Method in class org.ehcache.config.builders.WriteBehindConfigurationBuilder.UnBatchedWriteBehindConfigurationBuilder
Builder<T> - Interface in org.ehcache.config.builders
Abstraction of something that can build a T
builder(CacheManagerBuilder<? extends CacheManager>) - Method in interface org.ehcache.config.builders.CacheManagerConfiguration
Enables to refine the type that the CacheManagerBuilder will build.
builder(UserManagedCacheBuilder<K, V, ? extends UserManagedCache<K, V>>) - Method in interface org.ehcache.config.builders.UserManagedCacheConfiguration
Enables to refine the type that the UserManagedCacheBuilder will build.
BulkCacheLoadingException - Exception in org.ehcache.exceptions
Exception thrown by a Cache when the CacheLoaderWriter it uses threw an RuntimeException while bulk loading values for a given set of keys
BulkCacheLoadingException(Map<?, Exception>, Map<?, ?>) - Constructor for exception org.ehcache.exceptions.BulkCacheLoadingException
Constructs a new BulkCacheLoadingException providing the key set that failed, including the exception loading these threw, as well as all keys we managed to load a value for, including the value loaded.
BulkCacheLoadingException(String, Map<Object, Exception>, Map<Object, Object>) - Constructor for exception org.ehcache.exceptions.BulkCacheLoadingException
Constructs a new BulkCacheLoadingException providing a message, the key set that failed, including the exception loading these threw, as well as all keys we managed to load a value for, including the value loaded.
BulkCacheWritingException - Exception in org.ehcache.exceptions
Exception thrown by a Cache when the CacheLoaderWriter it uses threw an exception while bulk writing / removing values for a given set of keys
BulkCacheWritingException(Map<?, Exception>, Set<?>) - Constructor for exception org.ehcache.exceptions.BulkCacheWritingException
Constructs a new BulkCacheWritingException providing the key set that failed, including the exception loading these threw, as well as all keys we managed to write a value for.

C

Cache<K,V> - Interface in org.ehcache
Basic interface to a cache, defines all operational methods to create, access, update or delete mappings of key to value
Cache.Entry<K,V> - Interface in org.ehcache
Represent a mapping of key to value held in a Cache
CacheConfiguration<K,V> - Interface in org.ehcache.config
Represents the minimal read-only configuration for a Cache to be, or an already existing one
CacheConfigurationBuilder<K,V> - Class in org.ehcache.config.builders
The CacheConfigurationBuilder enables building CacheConfigurations using a fluent style.
CacheEvent<K,V> - Interface in org.ehcache.event
An event resulting from a mutative Cache operation.
CacheEventListener<K,V> - Interface in org.ehcache.event
Contract for users that want to listen on CacheEvents.
CacheEventListenerConfiguration - Interface in org.ehcache.event
Configuration contract for setting up CacheEvent system in a cache.
CacheEventListenerConfigurationBuilder - Class in org.ehcache.config.builders
The CacheEventListenerConfigurationBuilder enables building CacheEventListenerConfigurations using a fluent style.
CacheEventListenerProvider - Interface in org.ehcache.event
 
CacheIterationException - Exception in org.ehcache.exceptions
Created by alsu on 09/10/15.
CacheIterationException() - Constructor for exception org.ehcache.exceptions.CacheIterationException
Creates an exception.
CacheIterationException(String) - Constructor for exception org.ehcache.exceptions.CacheIterationException
Creates an exception with the provided message.
CacheIterationException(String, Throwable) - Constructor for exception org.ehcache.exceptions.CacheIterationException
Creates an exception with the provided message and cause.
CacheIterationException(Throwable) - Constructor for exception org.ehcache.exceptions.CacheIterationException
Creates an exception with the provided cause.
CacheLoaderWriter<K,V> - Interface in org.ehcache.spi.loaderwriter
A CacheLoaderWriter is associated with a given Cache instance and will be used to keep it in sync with another system.
CacheLoaderWriterProvider - Interface in org.ehcache.spi.loaderwriter
A factory Service that will create CacheLoaderWriter instances for a given Cache managed by a CacheManager The CacheManager will request an instance of this Class prior to creating any Cache instances.
CacheLoadingException - Exception in org.ehcache.exceptions
Exception thrown by a Cache when the CacheLoaderWriter it uses threw an Exception while loading a value for a given key.
CacheLoadingException() - Constructor for exception org.ehcache.exceptions.CacheLoadingException
Constructs a CacheLoadingException
CacheLoadingException(String) - Constructor for exception org.ehcache.exceptions.CacheLoadingException
Constructs a CacheLoadingException with the provided message.
CacheLoadingException(String, Throwable) - Constructor for exception org.ehcache.exceptions.CacheLoadingException
Constructs a CacheLoadingException wrapping the cause passed in and with the provided message.
CacheLoadingException(Throwable) - Constructor for exception org.ehcache.exceptions.CacheLoadingException
Constructs a CacheLoadingException wrapping the cause passed in.
CacheManager - Interface in org.ehcache
A CacheManager that manages Cache as well as associated Service
CacheManagerBuilder<T extends CacheManager> - Class in org.ehcache.config.builders
The CacheManagerBuilder enables building cache managers using a fluent style.
CacheManagerConfiguration<T extends CacheManager> - Interface in org.ehcache.config.builders
A configuration type that enables to further specify the type of CacheManager in a CacheManagerBuilder.
CachePersistenceException - Exception in org.ehcache.exceptions
Exception that can occur from operations on PersistentCacheManager.
CachePersistenceException(String) - Constructor for exception org.ehcache.exceptions.CachePersistenceException
Creates an exception with the provided message.
CachePersistenceException(String, Throwable) - Constructor for exception org.ehcache.exceptions.CachePersistenceException
Creates an exception with the provided message and cause.
CacheRuntimeConfiguration<K,V> - Interface in org.ehcache.config
Represents the configuration currently used by a Cache.
CacheWritingException - Exception in org.ehcache.exceptions
Exception thrown by a Cache when the CacheLoaderWriter it uses threw an Exception while writing a value for a given key
CacheWritingException() - Constructor for exception org.ehcache.exceptions.CacheWritingException
Constructs a CacheWritingException
CacheWritingException(String) - Constructor for exception org.ehcache.exceptions.CacheWritingException
Constructs a CacheWritingException with the provided message.
CacheWritingException(String, Throwable) - Constructor for exception org.ehcache.exceptions.CacheWritingException
Constructs a CacheWritingException wrapping the cause passed in and with the provided message.
CacheWritingException(Throwable) - Constructor for exception org.ehcache.exceptions.CacheWritingException
Constructs a CacheWritingException wrapping the cause passed in.
clear() - Method in interface org.ehcache.Cache
Removes all mapping currently present in the Cache without invoking the CacheLoaderWriter or any registered CacheEventListener instances This is not an atomic operation and can potentially be very expensive
clearAllServiceConfig() - Method in class org.ehcache.config.builders.CacheConfigurationBuilder
Clears all ServiceConfigurations from the returned builder.
close() - Method in interface org.ehcache.CacheManager
Releases all data held in Cache instances managed by this CacheManager, as well as all Service this instance provides to managed Cache instances.
close() - Method in interface org.ehcache.Maintainable
Exit maintenance mode
close() - Method in interface org.ehcache.spi.LifeCycled
Callback used by internal life cycling infrastructure when transitioning from Status.AVAILABLE to Status.UNINITIALIZED
Throwing an Exception here, will fail the transition
close() - Method in interface org.ehcache.UserManagedCache
Releases all data held in this UserManagedCache.
compareTo(long, long, ResourceUnit) - Method in interface org.ehcache.config.ResourceUnit
Compare thisSize of this unit to thatSize of thatUnit.
compareTo(long, long, ResourceUnit) - Method in enum org.ehcache.config.units.MemoryUnit
 
concurrency - Variable in class org.ehcache.config.builders.WriteBehindConfigurationBuilder
 
concurrencyLevel(int) - Method in class org.ehcache.config.builders.WriteBehindConfigurationBuilder.BatchedWriteBehindConfigurationBuilder
Sets the concurrency level on the returned builder.
concurrencyLevel(int) - Method in class org.ehcache.config.builders.WriteBehindConfigurationBuilder
Sets the concurrency level on the returned builder.
concurrencyLevel(int) - Method in class org.ehcache.config.builders.WriteBehindConfigurationBuilder.UnBatchedWriteBehindConfigurationBuilder
Sets the concurrency level on the returned builder.
Configuration - Interface in org.ehcache.config
 
constructedWith(Object...) - Method in class org.ehcache.config.builders.CacheEventListenerConfigurationBuilder
Adds arguments that will be passed to the constructor of the CacheEventListener subclass configured previously.
containsKey(K) - Method in interface org.ehcache.Cache
Checks whether a mapping for the given key is present, without retrieving the associated value
convert(long, MemoryUnit) - Method in enum org.ehcache.config.units.MemoryUnit
Returns amount in unit in to this unit.
Copier<T> - Interface in org.ehcache.spi.copy
Interface defining the contract used to make a copy of types.
copyForRead(T) - Method in interface org.ehcache.spi.copy.Copier
Creates a copy of the instance passed in.
copyForWrite(T) - Method in interface org.ehcache.spi.copy.Copier
Creates a copy of the instance passed in.
CopyProvider - Interface in org.ehcache.spi.copy
 
create() - Method in interface org.ehcache.Maintainable
Creates all persistent data structures required to function
create() - Method in interface org.ehcache.spi.service.PersistableResourceService
Creates the persistent storage.
createCache(String, CacheConfiguration<K, V>) - Method in interface org.ehcache.CacheManager
Creates a Cache in this CacheManager according to the specified CacheConfiguration.
createCacheLoaderWriter(String, CacheConfiguration<K, V>) - Method in interface org.ehcache.spi.loaderwriter.CacheLoaderWriterProvider
Invoked by the CacheManager when a Cache is being added to it.
createEventListener(String, ServiceConfiguration<CacheEventListenerProvider>) - Method in interface org.ehcache.event.CacheEventListenerProvider
Creates a new CacheEventListener
createKeyCopier(Class<T>, Serializer<T>, ServiceConfiguration<?>...) - Method in interface org.ehcache.spi.copy.CopyProvider
Creates a key Copier with the given parameters.
createKeySerializer(Class<T>, ClassLoader, ServiceConfiguration<?>...) - Method in interface org.ehcache.spi.serialization.SerializationProvider
Creates a key Serializer with the given parameters.
createValueCopier(Class<T>, Serializer<T>, ServiceConfiguration<?>...) - Method in interface org.ehcache.spi.copy.CopyProvider
Creates a value Copier with the given parameters.
createValueSerializer(Class<T>, ClassLoader, ServiceConfiguration<?>...) - Method in interface org.ehcache.spi.serialization.SerializationProvider
Creates a value Serializer with the given parameters.
createWriteBehindLoaderWriter(CacheLoaderWriter<K, V>, WriteBehindConfiguration) - Method in interface org.ehcache.spi.loaderwriter.WriteBehindProvider
Provider Interface for decorator loaderwriter

D

defaultPool(String, int, int) - Method in class org.ehcache.config.builders.PooledExecutionServiceConfigurationBuilder
Adds a default pool configuration to the returned builder.
delete(K) - Method in interface org.ehcache.spi.loaderwriter.CacheLoaderWriter
Deletes a single entry from the underlying system of record.
deleteAll(Iterable<? extends K>) - Method in interface org.ehcache.spi.loaderwriter.CacheLoaderWriter
Deletes a set of entry from the underlying system of record.
deregisterCacheEventListener(CacheEventListener<? super K, ? super V>) - Method in interface org.ehcache.config.CacheRuntimeConfiguration
Allows for deregistering of a previously registered CacheEventListener instance
destroy() - Method in interface org.ehcache.Maintainable
Destroys all persistent data structures
destroy(String) - Method in interface org.ehcache.spi.service.PersistableResourceService
Destroys the persistence space with the given name.
destroyAll() - Method in interface org.ehcache.spi.service.PersistableResourceService
Destroys all persistence spaces Note that this method can be called without creating the persistence space beforehand in the same JVM.
destroyCache(String) - Method in interface org.ehcache.PersistentCacheManager
Destroys all data persistent data associated with the aliased Cache instance managed by this CacheManager
disableCoalescing() - Method in class org.ehcache.config.builders.WriteBehindConfigurationBuilder.BatchedWriteBehindConfigurationBuilder
Disables batch coalescing on the returned builder.
disk(long, MemoryUnit) - Method in class org.ehcache.config.builders.ResourcePoolsBuilder
Convenience method to add a non persistent ResourceType.Core.DISK pool.
disk(long, MemoryUnit, boolean) - Method in class org.ehcache.config.builders.ResourcePoolsBuilder
Convenience method to add a ResourceType.Core.DISK pool specifying persistence.
Duration - Class in org.ehcache.expiry
A unit of time in a given TimeUnit
Duration(long, TimeUnit) - Constructor for class org.ehcache.expiry.Duration
Construct a Duration instance

E

enableCoalescing() - Method in class org.ehcache.config.builders.WriteBehindConfigurationBuilder.BatchedWriteBehindConfigurationBuilder
Enables batch coalescing on the returned builder.
EntryUnit - Enum in org.ehcache.config.units
An enumeration implementing ResourceUnit to represent entries count.
equals(Object) - Method in class org.ehcache.expiry.Duration
 
equals(T, ByteBuffer) - Method in interface org.ehcache.spi.serialization.Serializer
Checks if the given instance and serial form are representations of the same instance.
EventFiring - Enum in org.ehcache.event
 
eventOrdering(EventOrdering) - Method in class org.ehcache.config.builders.CacheEventListenerConfigurationBuilder
Adds specific EventOrdering to the returned builder.
EventOrdering - Enum in org.ehcache.event
 
EventType - Enum in org.ehcache.event
 
Eviction - Class in org.ehcache.config
Utility class for getting predefined EvictionVeto instance.
Eviction() - Constructor for class org.ehcache.config.Eviction
 
EvictionVeto<K,V> - Interface in org.ehcache.config
A specialized predicate used to veto eviction of cache entries.
Expirations - Class in org.ehcache.expiry
Utility class for getting predefined Expiry instances.
Expiry<K,V> - Interface in org.ehcache.expiry
A policy object that governs expiration for a Cache.

F

fireOn() - Method in interface org.ehcache.event.CacheEventListenerConfiguration
Indicates on which EventType an event has to be fired
firingMode(EventFiring) - Method in class org.ehcache.config.builders.CacheEventListenerConfigurationBuilder
Adds specific EventFiring to the returned builder.
firingMode() - Method in interface org.ehcache.event.CacheEventListenerConfiguration
Indicates which firing mode to use
FOREVER - Static variable in class org.ehcache.expiry.Duration
Special Duration value that indicates an infinite amount of time.

G

get(K) - Method in interface org.ehcache.Cache
Retrieve the value currently mapped to the provided key
getAll(Set<? extends K>) - Method in interface org.ehcache.Cache
Retrieves all values associated with the given keys.
getAmount() - Method in class org.ehcache.expiry.Duration
Get the amount of Duration.getTimeUnit() this instance represents
getBatchingConfiguration() - Method in interface org.ehcache.spi.loaderwriter.WriteBehindConfiguration
Returns the batching configuration or null if batching is not enabled.
getBatchSize() - Method in interface org.ehcache.spi.loaderwriter.WriteBehindConfiguration.BatchingConfiguration
The recommended size of a batch of operations.
getCache(String, Class<K>, Class<V>) - Method in interface org.ehcache.CacheManager
Retrieves the Cache associated with the given alias, if one is known.
getCacheConfigurations() - Method in interface org.ehcache.config.Configuration
Mapping of names to CacheConfiguration, used to create the named Cache managed by a CacheManager
getClassLoader() - Method in interface org.ehcache.config.CacheConfiguration
The ClassLoader for this cache.
getClassLoader() - Method in interface org.ehcache.config.Configuration
The ClassLoader to be associated with the CacheManager
getConcurrency() - Method in interface org.ehcache.spi.loaderwriter.WriteBehindConfiguration
A number of bucket/thread pairs configured for this cache's write behind.
getEvictionVeto() - Method in interface org.ehcache.config.CacheConfiguration
The EvictionVeto predicate function.
getExistingServiceConfiguration(Class<T>) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder
Returns the first ServiceConfiguration with type matching the class passed in.
getExistingServiceConfigurations(Class<T>) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder
Returns all ServiceConfigurations of type matching the class passed in.
getExpiry() - Method in interface org.ehcache.config.CacheConfiguration
Get the expiration policy instance for the Cache.
getExpiryForAccess(K, ValueSupplier<? extends V>) - Method in interface org.ehcache.expiry.Expiry
Get the expiration period (relative to the current time) when an existing entry is accessed from a Cache
getExpiryForCreation(K, V) - Method in interface org.ehcache.expiry.Expiry
Get the expiration period (relative to the current time) when a entry is initially added to a Cache
getExpiryForUpdate(K, ValueSupplier<? extends V>, V) - Method in interface org.ehcache.expiry.Expiry
Get the expiration period (relative to the current time) when an existing entry is updated in a Cache NOTE: Some cache configurations (eg.
getFailures() - Method in exception org.ehcache.exceptions.BulkCacheLoadingException
Accessor to all keys that failed loading during a bulk load operation, with the associated Exception encountered
getFailures() - Method in exception org.ehcache.exceptions.BulkCacheWritingException
Accessor to all keys that failed loading during a bulk load operation, with the associated Exception encountered
getKey() - Method in interface org.ehcache.Cache.Entry
Accessor to the key of this mapping
getKey() - Method in interface org.ehcache.event.CacheEvent
The key of the mapping affected by the mutative event
getKeyType() - Method in interface org.ehcache.config.CacheConfiguration
The type of the key for the cache.
getMaxDelay() - Method in interface org.ehcache.spi.loaderwriter.WriteBehindConfiguration.BatchingConfiguration
The maximum time to wait before writing behind.
getMaxDelayUnit() - Method in interface org.ehcache.spi.loaderwriter.WriteBehindConfiguration.BatchingConfiguration
The time unit for the maximum delay.
getMaxQueueSize() - Method in interface org.ehcache.spi.loaderwriter.WriteBehindConfiguration
The maximum number of operations allowed on the write behind queue.
getNewValue() - Method in interface org.ehcache.event.CacheEvent
The mapped value immediately after the mutative event occurred.
getOldValue() - Method in interface org.ehcache.event.CacheEvent
The mapped value immediately before the mutative event occurred.
getPoolForResource(ResourceType) - Method in interface org.ehcache.config.ResourcePools
Get a specific ResourcePool based on its type.
getResourcePools() - Method in interface org.ehcache.config.CacheConfiguration
Get the resource pools the Cache can make use of.
getResourceTypeSet() - Method in interface org.ehcache.config.ResourcePools
Get the set of ResourceType of all the pools present in the ResourcePools
getRuntimeConfiguration() - Method in interface org.ehcache.Cache
Exposes the CacheRuntimeConfiguration associated with this Cache instance.
getRuntimeConfiguration() - Method in interface org.ehcache.CacheManager
Returns the current RuntimeConfiguration used by this CacheManager
getService(Class<U>) - Method in interface org.ehcache.spi.ServiceProvider
Will look up the Service of the serviceType.
getServiceConfigurations() - Method in interface org.ehcache.config.CacheConfiguration
Not sure whether this should be exposed on this interface really.
getServiceCreationConfigurations() - Method in interface org.ehcache.config.Configuration
All services initially used to bootstrap the CacheManager and its Cache instances
getServicesOfType(Class<U>) - Method in interface org.ehcache.spi.ServiceProvider
Looks up all Service instances registered to support the serviceType supplied.
getServiceType() - Method in interface org.ehcache.spi.service.ServiceConfiguration
Indicates which service this configuration works with.
getServiceType() - Method in interface org.ehcache.spi.service.ServiceCreationConfiguration
Indicates which service consumes this configuration at creation.
getSize() - Method in interface org.ehcache.config.ResourcePool
Get the value measuring the pool size.
getSource() - Method in interface org.ehcache.event.CacheEvent
Deprecated.
getStatus() - Method in interface org.ehcache.CacheManager
Returns the current Status for this CacheManager
getStatus() - Method in interface org.ehcache.UserManagedCache
Returns the current Status for this CacheManager
getSuccesses() - Method in exception org.ehcache.exceptions.BulkCacheLoadingException
Accessor to all keys that were successfully loaded during a bulk load operation, with the associated loaded value
getSuccesses() - Method in exception org.ehcache.exceptions.BulkCacheWritingException
Accessor to all keys that were successfully loaded during a bulk load operation
getThreadPoolAlias() - Method in interface org.ehcache.spi.loaderwriter.WriteBehindConfiguration
Returns the alias of the thread resource pool to use for write behind task execution.
getTimeUnit() - Method in class org.ehcache.expiry.Duration
Get the TimeUnit of this instance
getType() - Method in interface org.ehcache.config.ResourcePool
Get the type of the tracked resource.
getType() - Method in interface org.ehcache.event.CacheEvent
The type of mutative event
getUnit() - Method in interface org.ehcache.config.ResourcePool
Get the unit in which the resource is measured.
getValue() - Method in interface org.ehcache.Cache.Entry
Accessor to the value of this mapping
getValueType() - Method in interface org.ehcache.config.CacheConfiguration
The type of the value held in the cache.

H

handlesResourceType(ResourceType) - Method in interface org.ehcache.spi.service.PersistableResourceService
Indicates whether this service handles the type of resource passed in.
hasConfiguredExpiry() - Method in class org.ehcache.config.builders.CacheConfigurationBuilder
Indicates whether this builder has configured expiry or not.
hashCode() - Method in class org.ehcache.expiry.Duration
 
heap(long, ResourceUnit) - Method in class org.ehcache.config.builders.ResourcePoolsBuilder
Convenience method to add a ResourceType.Core.HEAP pool.

I

identifier(String) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder
Adds an identifier to the returned builder.
init() - Method in interface org.ehcache.CacheManager
Attempts at having this CacheManager go to Status.AVAILABLE, starting all Service instances managed by this CacheManager, as well as all Cache pre registered with it.
init() - Method in interface org.ehcache.spi.LifeCycled
Callback used by internal life cycling infrastructure when transitioning from Status.UNINITIALIZED to Status.AVAILABLE
Throwing an Exception here, will fail the transition
init() - Method in interface org.ehcache.UserManagedCache
Attempts at having this UserManagedCache go to Status.AVAILABLE.
isCoalescing() - Method in interface org.ehcache.spi.loaderwriter.WriteBehindConfiguration.BatchingConfiguration
Whether write operations can be coalesced.
isForever() - Method in class org.ehcache.expiry.Duration
Is this duration "forever" / infinite
isOrdered() - Method in enum org.ehcache.event.EventOrdering
Indicates if the value obeys ordering
isPersistable() - Method in enum org.ehcache.config.ResourceType.Core
 
isPersistable() - Method in interface org.ehcache.config.ResourceType
Whether the resource supports persistence.
isPersistent() - Method in interface org.ehcache.config.ResourcePool
Whether the underlying resource is persistent

L

LifeCycled - Interface in org.ehcache.spi
Internal interface to register hooks with the life cycle of Cache or CacheManager instances.
load(K) - Method in interface org.ehcache.spi.loaderwriter.CacheLoaderWriter
Loads the value to be associated with the given key in the Cache using this CacheLoaderWriter instance.
loadAll(Iterable<? extends K>) - Method in interface org.ehcache.spi.loaderwriter.CacheLoaderWriter
Loads the values to be associated with the keys in the Cache using this CacheLoaderWriter instance.

M

Maintainable - Interface in org.ehcache
 
MaintainableService - Interface in org.ehcache.spi.service
Specific Service interface that indicates that the service participates in maintenance mode
maxWriteDelay(long, TimeUnit) - Method in class org.ehcache.config.builders.WriteBehindConfigurationBuilder.BatchedWriteBehindConfigurationBuilder
Updates the max write delay on the returned builder.
MemoryUnit - Enum in org.ehcache.config.units
An enumeration implementing ResourceUnit to represent memory consumption.

N

newBatchedWriteBehindConfiguration(long, TimeUnit, int) - Static method in class org.ehcache.config.builders.WriteBehindConfigurationBuilder
Creates a new builder for WriteBehindConfiguration that supports batching.
newCacheConfigurationBuilder(Class<K>, Class<V>) - Static method in class org.ehcache.config.builders.CacheConfigurationBuilder
Creates a new instance ready to produce a CacheConfiguration with key type <K> and with value type <V>.
newCacheManager(Configuration) - Static method in class org.ehcache.config.builders.CacheManagerBuilder
Creates a new CacheManager based on the provided configuration
newCacheManagerBuilder() - Static method in class org.ehcache.config.builders.CacheManagerBuilder
Creates a new CacheManagerBuilder
newEventListenerConfiguration(Class<? extends CacheEventListener<?, ?>>, EventType, EventType...) - Static method in class org.ehcache.config.builders.CacheEventListenerConfigurationBuilder
Creates a new builder instance using the given CacheEventListener subclass and the EventTypes it will listen to.
newEventListenerConfiguration(CacheEventListener<?, ?>, EventType, EventType...) - Static method in class org.ehcache.config.builders.CacheEventListenerConfigurationBuilder
Creates a new builder instance using the given CacheEventListener instance and the EventTypes it will listen to.
newEventListenerConfiguration(Class<? extends CacheEventListener<?, ?>>, Set<EventType>) - Static method in class org.ehcache.config.builders.CacheEventListenerConfigurationBuilder
Creates a new builder instance using the given CacheEventListener subclass and the set of EventTypes to listen to.
newEventListenerConfiguration(CacheEventListener<?, ?>, Set<EventType>) - Static method in class org.ehcache.config.builders.CacheEventListenerConfigurationBuilder
Creates a new builder instance using the given CacheEventListener instance and the set of EventTypes to listen to.
newPooledExecutionServiceConfigurationBuilder() - Static method in class org.ehcache.config.builders.PooledExecutionServiceConfigurationBuilder
Creates a new instance of PooledExecutionServiceConfigurationBuilder
newResourcePoolsBuilder() - Static method in class org.ehcache.config.builders.ResourcePoolsBuilder
Creates a new ResourcePoolsBuilder.
newResourcePoolsBuilder(ResourcePools) - Static method in class org.ehcache.config.builders.ResourcePoolsBuilder
Convenience method to get a builder from an existing ResourcePools.
newUnBatchedWriteBehindConfiguration() - Static method in class org.ehcache.config.builders.WriteBehindConfigurationBuilder
Creates a new builder for WriteBehindConfiguration without batching support.
newUserManagedCacheBuilder(Class<K>, Class<V>) - Static method in class org.ehcache.config.builders.UserManagedCacheBuilder
Creates a new UserManagedCacheBuilder.
noExpiration() - Static method in class org.ehcache.expiry.Expirations
Get an Expiry instance for a non expiring (ie.
none() - Static method in class org.ehcache.config.Eviction
Returns an EvictionVeto where no mappings are vetoed from eviction.

O

offheap(long, MemoryUnit) - Method in class org.ehcache.config.builders.ResourcePoolsBuilder
Convenience method to add a ResourceType.Core.OFFHEAP pool.
onEvent(CacheEvent<K, V>) - Method in interface org.ehcache.event.CacheEventListener
Invoked on any CacheEvent matching the EventType constrain used when the listener was registered.
ordered() - Method in class org.ehcache.config.builders.CacheEventListenerConfigurationBuilder
Sets the returned builder for ordered event processing.
orderingMode() - Method in interface org.ehcache.event.CacheEventListenerConfiguration
Indicates which ordering mode to use
org.ehcache - package org.ehcache
Main Ehcache API package
org.ehcache.config - package org.ehcache.config
Package for Cache configuration classes
org.ehcache.config.builders - package org.ehcache.config.builders
Package for builders designed to help out with programmatic configuration of Ehcache
org.ehcache.config.units - package org.ehcache.config.units
Package for ResourceUnit implementations
org.ehcache.event - package org.ehcache.event
Package for all Cache related events
org.ehcache.exceptions - package org.ehcache.exceptions
Package for all Cache related exceptions
org.ehcache.expiry - package org.ehcache.expiry
Package for the expiry API of a Cache
org.ehcache.spi - package org.ehcache.spi
Top level package for all things SPI in Ehcache
org.ehcache.spi.copy - package org.ehcache.spi.copy
Package for SPI related to copiers in Ehcache
org.ehcache.spi.loaderwriter - package org.ehcache.spi.loaderwriter
Package holding the loader/writer SPI for a Cache
org.ehcache.spi.serialization - package org.ehcache.spi.serialization
Package for SPI related to serialization in Ehcache
org.ehcache.spi.service - package org.ehcache.spi.service
Package for SPI related to CacheManager services

P

PersistableResourceService - Interface in org.ehcache.spi.service
Specific interface for services that are dedicated to handling a ResourceType which is persistable.
persistence(String) - Static method in class org.ehcache.config.builders.CacheManagerBuilder
Convenience method to get a CacheManagerConfiguration for a PersistentCacheManager.
PersistentCacheManager - Interface in org.ehcache
A CacheManager that knows how to lifecycle Cache data that outlive the JVM's process existence.
PersistentUserManagedCache<K,V> - Interface in org.ehcache
A UserManagedCache that holds data that outlives the JVM's process
PluralService - Annotation Type in org.ehcache.spi.service
Used to indicate that a Service subtype is permitted to have more than one concrete implementation registered with a ServiceProvider.
pool(String, int, int) - Method in class org.ehcache.config.builders.PooledExecutionServiceConfigurationBuilder
Adds a pool configuration to the returned builder.
PooledExecutionServiceConfigurationBuilder - Class in org.ehcache.config.builders
The PooledExecutionServiceConfigurationBuilder enables building configurations for an ExecutionService that is pool based using a fluent style.
put(K, V) - Method in interface org.ehcache.Cache
Associates the provided value to the given key
putAll(Map<? extends K, ? extends V>) - Method in interface org.ehcache.Cache
Associates all the provided key:value pairs.
putIfAbsent(K, V) - Method in interface org.ehcache.Cache
If the provided key is not associated with a value, then associate it with the provided value.

Q

queueSize(int) - Method in class org.ehcache.config.builders.WriteBehindConfigurationBuilder.BatchedWriteBehindConfigurationBuilder
Sets the batch queue size on the returned builder.
queueSize - Variable in class org.ehcache.config.builders.WriteBehindConfigurationBuilder
 
queueSize(int) - Method in class org.ehcache.config.builders.WriteBehindConfigurationBuilder
Sets the batch queue size on the returned builder.
queueSize(int) - Method in class org.ehcache.config.builders.WriteBehindConfigurationBuilder.UnBatchedWriteBehindConfigurationBuilder
Sets the batch queue size on the returned builder.

R

read(ByteBuffer) - Method in interface org.ehcache.spi.serialization.Serializer
Reconstructs an instance from the given serial form.
registerCacheEventListener(CacheEventListener<? super K, ? super V>, EventOrdering, EventFiring, Set<EventType>) - Method in interface org.ehcache.config.CacheRuntimeConfiguration
Allows for registering CacheEventListener on the cache
registerCacheEventListener(CacheEventListener<? super K, ? super V>, EventOrdering, EventFiring, EventType, EventType...) - Method in interface org.ehcache.config.CacheRuntimeConfiguration
Allows for registering CacheEventListener on the cache
releaseCacheLoaderWriter(CacheLoaderWriter<?, ?>) - Method in interface org.ehcache.spi.loaderwriter.CacheLoaderWriterProvider
Invoked by CacheManager when a Cache is being removed from it.
releaseEventListener(CacheEventListener<?, ?>) - Method in interface org.ehcache.event.CacheEventListenerProvider
Releases a given CacheEventListener
releaseSerializer(Serializer<?>) - Method in interface org.ehcache.spi.serialization.SerializationProvider
Releases the given Serializer instance
releaseWriteBehindLoaderWriter(CacheLoaderWriter<?, ?>) - Method in interface org.ehcache.spi.loaderwriter.WriteBehindProvider
Invoked by CacheManager when a Cache is being removed from it.
remove(K) - Method in interface org.ehcache.Cache
Removes the value, if any, associated with the provided key
remove(K, V) - Method in interface org.ehcache.Cache
If the provided key is associated with the provided value then remove the entry.
remove(ServiceConfiguration<?>) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder
Removes a ServiceConfiguration from the returned builder.
removeAll(Set<? extends K>) - Method in interface org.ehcache.Cache
Removes any associates for the given keys.
removeCache(String) - Method in interface org.ehcache.CacheManager
Removes the Cache associated with the alias provided, if oe is known.
replace(K, V) - Method in interface org.ehcache.Cache
If the provided key is associated with a value, then replace that value with the provided value.
replace(K, V, V) - Method in interface org.ehcache.Cache
If the provided key is associated with oldValue, then replace that value with newValue.
replacing(ServiceCreationConfiguration<?>) - Method in class org.ehcache.config.builders.CacheManagerBuilder
Replaces an existing ServiceCreationConfiguration of the same type on the returned builder.
requiresSerialization() - Method in enum org.ehcache.config.ResourceType.Core
 
requiresSerialization() - Method in interface org.ehcache.config.ResourceType
Whether the resource requires serialization support.
ResourcePool - Interface in org.ehcache.config
 
ResourcePools - Interface in org.ehcache.config
A collection of resource pools a cache has at its disposal to store its mappings.
ResourcePoolsBuilder - Class in org.ehcache.config.builders
The ResourcePoolsBuilder enables building ResourcePools configurations using a fluent style.
ResourceType - Interface in org.ehcache.config
The resource pools type interface.
ResourceType.Core - Enum in org.ehcache.config
An enumeration of resource types handled by core ehcache.
ResourceUnit - Interface in org.ehcache.config
 
RuntimeConfiguration - Interface in org.ehcache.config
Marker interface for now, there isn't anything mutable here yet...

S

SerializationProvider - Interface in org.ehcache.spi.serialization
Contract to provide a Serializer for a given type.
serialize(T) - Method in interface org.ehcache.spi.serialization.Serializer
Transforms the given instance into its serial form.
Serializer<T> - Interface in org.ehcache.spi.serialization
Interface defining the contract used to transform types in a serial form.
SerializerException - Exception in org.ehcache.exceptions
Exception thrown by a Cache when a store cannot serialize or deserialize a value.
SerializerException() - Constructor for exception org.ehcache.exceptions.SerializerException
Creates an exception.
SerializerException(String) - Constructor for exception org.ehcache.exceptions.SerializerException
Creates an exception with the provided message.
SerializerException(String, Throwable) - Constructor for exception org.ehcache.exceptions.SerializerException
Creates an exception with the provided message and cause.
SerializerException(Throwable) - Constructor for exception org.ehcache.exceptions.SerializerException
Creates an exception with the provided cause.
Service - Interface in org.ehcache.spi.service
Contract for a CacheManager managed service.
ServiceConfiguration<T extends Service> - Interface in org.ehcache.spi.service
Interface regrouping configuration types to be used when interacting with a Service.
ServiceCreationConfiguration<T extends Service> - Interface in org.ehcache.spi.service
Interface regrouping configuration types to be used when creating a Service.
ServiceDependencies - Annotation Type in org.ehcache.spi.service
Annotation that enables a Service implementation to declare a dependency on other Services.
ServiceProvider<T extends Service> - Interface in org.ehcache.spi
This acts as a repository for Service instances, that can be used to look them up by type.
start(ServiceProvider<Service>) - Method in interface org.ehcache.spi.service.Service
Start this service using the provided configuration and ServiceProvider.
startForMaintenance(ServiceProvider<MaintainableService>) - Method in interface org.ehcache.spi.service.MaintainableService
Start this service for maintenance, based on its default configuration.
StateTransitionException - Exception in org.ehcache.exceptions
Exception indicating that a state transition failed.
StateTransitionException(Throwable) - Constructor for exception org.ehcache.exceptions.StateTransitionException
Creates an exception with the provided cause.
Status - Enum in org.ehcache
 
stop() - Method in interface org.ehcache.spi.service.Service
Stops this service.
StoreAccessException - Exception in org.ehcache.exceptions
Generic exception used when an internal operation fails on a Cache.
StoreAccessException(Throwable) - Constructor for exception org.ehcache.exceptions.StoreAccessException
Creates a new exception wrapping the cause passed in.
StoreAccessException(String, Throwable) - Constructor for exception org.ehcache.exceptions.StoreAccessException
Creates a new exception wrapping the cause passed in and with the provided message.
StoreAccessException(String) - Constructor for exception org.ehcache.exceptions.StoreAccessException
Creates a new exception with the provided message.
synchronous() - Method in class org.ehcache.config.builders.CacheEventListenerConfigurationBuilder
Sets the returned builder for synchronous event processing.

T

threadPoolAlias - Variable in class org.ehcache.config.builders.WriteBehindConfigurationBuilder
 
timeToIdleExpiration(Duration) - Static method in class org.ehcache.expiry.Expirations
Get a time-to-idle (TTI) Expiry instance for the given duration
timeToLiveExpiration(Duration) - Static method in class org.ehcache.expiry.Expirations
Get a time-to-live (TTL) Expiry instance for the given duration
toBytes(long) - Method in enum org.ehcache.config.units.MemoryUnit
Returns the size in bytes according to the unit this is invoked on.
toMaintenance() - Method in interface org.ehcache.PersistentCacheManager
Lets you manipulate the persistent data structures for this PersistentCacheManager
toMaintenance() - Method in interface org.ehcache.PersistentUserManagedCache
Lets you manipulate the persistent data structures for this PersistentUserManagedCache
toString() - Method in enum org.ehcache.config.ResourceType.Core
 
toString() - Method in enum org.ehcache.config.units.MemoryUnit
 
toString() - Method in class org.ehcache.expiry.Duration
 

U

unordered() - Method in class org.ehcache.config.builders.CacheEventListenerConfigurationBuilder
Sets the returned builder for unordered event processing.
UnsupportedTypeException - Exception in org.ehcache.spi.serialization
Exception thrown to indicate a Serializer could not be created for a given type.
UnsupportedTypeException(String) - Constructor for exception org.ehcache.spi.serialization.UnsupportedTypeException
Constructs a new exception with the specified detail message.
updateResourcePools(ResourcePools) - Method in interface org.ehcache.config.CacheRuntimeConfiguration
updates ResourcePools
UserManagedCache<K,V> - Interface in org.ehcache
Represents a Cache that is not managed by a CacheManager, as such that needs to have UserManagedCache.close() invoked in order to release all its resources.
UserManagedCacheBuilder<K,V,T extends UserManagedCache<K,V>> - Class in org.ehcache.config.builders
The UserManagedCacheBuilder enables building UserManagedCaches using a fluent style.
UserManagedCacheConfiguration<K,V,T extends UserManagedCache<K,V>> - Interface in org.ehcache.config.builders
A configuration type that enables to further specify the type of UserManagedCache in a UserManagedCacheBuilder.
useThreadPool(String) - Method in class org.ehcache.config.builders.WriteBehindConfigurationBuilder.BatchedWriteBehindConfigurationBuilder
Sets the thread pool to use for write behind on the returned builder.
useThreadPool(String) - Method in class org.ehcache.config.builders.WriteBehindConfigurationBuilder.UnBatchedWriteBehindConfigurationBuilder
Sets the thread pool to use for write behind on the returned builder.
useThreadPool(String) - Method in class org.ehcache.config.builders.WriteBehindConfigurationBuilder
Sets the thread pool to use for write behind on the returned builder.
using(Service) - Method in class org.ehcache.config.builders.CacheManagerBuilder
Adds a Service instance to the returned builder.
using(ServiceCreationConfiguration<?>) - Method in class org.ehcache.config.builders.CacheManagerBuilder
Adds a ServiceCreationConfiguration to the returned builder.
using(Service) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder
Adds a Service to be made available to the returned builder.
using(ServiceCreationConfiguration<?>) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder
Adds a ServiceCreationConfiguration, to trigger a service loading and its configuration, to the returned builder.

V

validateAndMerge(ResourcePools) - Method in interface org.ehcache.config.ResourcePools
Get a copy of the current ResourcePools merged with another ResourcePools and validate that the updates to the contained ResourcePools are legal.
value() - Method in interface org.ehcache.ValueSupplier
Returns the value behind this instance, possibly executing some logic.
valueOf(String) - Static method in enum org.ehcache.config.ResourceType.Core
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.ehcache.config.units.EntryUnit
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.ehcache.config.units.MemoryUnit
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.ehcache.event.EventFiring
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.ehcache.event.EventOrdering
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.ehcache.event.EventType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.ehcache.Status
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.ehcache.config.ResourceType.Core
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.ehcache.config.units.EntryUnit
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.ehcache.config.units.MemoryUnit
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.ehcache.event.EventFiring
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.ehcache.event.EventOrdering
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.ehcache.event.EventType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.ehcache.Status
Returns an array containing the constants of this enum type, in the order they are declared.
ValueSupplier<V> - Interface in org.ehcache
ValueSupplier creates an indirection to access a value.
vetoes(K, V) - Method in interface org.ehcache.config.EvictionVeto
Returns true if the given key value pair should be vetoed from eviction.

W

with(CacheManagerConfiguration<N>) - Method in class org.ehcache.config.builders.CacheManagerBuilder
Specializes the returned CacheManager subtype through a specific CacheManagerConfiguration which will optionally add configurations to the returned builder.
with(Builder<? extends CacheManagerConfiguration<N>>) - Method in class org.ehcache.config.builders.CacheManagerBuilder
Convenience method to specialize the returned CacheManager subtype through a CacheManagerConfiguration built using the provided Builder.
with(ResourceType, long, ResourceUnit, boolean) - Method in class org.ehcache.config.builders.ResourcePoolsBuilder
Adds or replace the ResourcePool of ResourceType in the returned builder.
with(UserManagedCacheConfiguration<K, V, N>) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder
Specifies the returned UserManagedCache subtype through a specific UserManagedCacheConfiguration which will optionally add configurations to the returned builder.
withCache(String, CacheConfiguration<K, V>) - Method in class org.ehcache.config.builders.CacheManagerBuilder
Adds a CacheConfiguration linked to the specified alias to the returned builder.
withCache(String, Builder<? extends CacheConfiguration<K, V>>) - Method in class org.ehcache.config.builders.CacheManagerBuilder
Convenience method to add a CacheConfiguration linked to the specified alias to the returned builder by building it from the provided Builder.
withClassLoader(ClassLoader) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder
Adds a ClassLoader to the returned builder.
withClassLoader(ClassLoader) - Method in class org.ehcache.config.builders.CacheManagerBuilder
Adds a ClassLoader, to use for non Ehcache types, to the returned builder
withClassLoader(ClassLoader) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder
Adds a ClassLoader, to load non Ehcache types, to the returned builder.
withCopier(Class<C>, Class<? extends Copier<C>>) - Method in class org.ehcache.config.builders.CacheManagerBuilder
Adds a default Copier for the specified type to the returned builder.
withDefaultDiskStoreThreadPool(String) - Method in class org.ehcache.config.builders.CacheManagerBuilder
Adds a OffHeapDiskStoreProviderConfiguration, that specifies the thread pool to use, to the returned builder.
withDefaultEventListenersThreadPool(String) - Method in class org.ehcache.config.builders.CacheManagerBuilder
Adds a CacheEventDispatcherFactoryConfiguration, that specifies the thread pool to use, to the returned builder.
withDefaultSizeOfMaxObjectGraph(long) - Method in class org.ehcache.config.builders.CacheManagerBuilder
Adds a default SizeOfEngine configuration, that limits the max object graph to size, to the returned builder.
withDefaultSizeOfMaxObjectSize(long, MemoryUnit) - Method in class org.ehcache.config.builders.CacheManagerBuilder
Adds a default SizeOfEngine configuration, that limits the max object size, to the returned builder.
withDefaultWriteBehindThreadPool(String) - Method in class org.ehcache.config.builders.CacheManagerBuilder
Adds a WriteBehindProviderConfiguration, that specifies the thread pool to use, to the returned builder.
withDiskStoreThreadPool(String, int) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder
Adds a ServiceConfiguration for the OffHeapDiskStore.Provider indicating thread pool alias and write concurrency.
withEventDispatcher(CacheEventDispatcher<K, V>) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder
Adds an CacheEventDispatcher to the returned builder.
withEventExecutors(ExecutorService, ExecutorService) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder
Adds the default CacheEventDispatcher using the provided ExecutorService to the returned builder.
withEventListeners(CacheEventListenerConfigurationBuilder) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder
Convenience method to add a CacheEventListenerConfiguration based on the provided CacheEventListenerConfigurationBuilder to the returned builder.
withEventListeners(CacheEventListenerConfiguration...) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder
Adds one or more CacheEventListenerConfiguration to the returned builder.
withEventListenersThreadPool(String) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder
Adds a ServiceConfiguration for the CacheEventDispatcherFactory specifying the thread pool alias to use.
withEvictionVeto(EvictionVeto<? super K, ? super V>) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder
Adds an EvictionVeto to the returned builder.
withEvictionVeto(EvictionVeto<K, V>) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder
Adds an EvictionVeto to the returned builder.
withExpiry(Expiry<? super K, ? super V>) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder
Adds Expiry configuration to the returned builder.
withExpiry(Expiry<K, V>) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder
Adds Expiry configuration to the returned builder.
withKeyCopier(Copier<K>) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder
Adds by-value semantic using the provided Copier for the key on heap.
withKeyCopier(Class<? extends Copier<K>>) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder
Adds by-value semantic using the provided Copier class for the key on heap.
withKeyCopier(Copier<K>) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder
Adds a configuration for key Copier to the returned builder.
withKeySerializer(Serializer<K>) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder
Adds a Serializer for cache keys to the configured builder.
withKeySerializer(Class<? extends Serializer<K>>) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder
Adds a Serializer class for cache keys to the configured builder.
withKeySerializer(Serializer<K>) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder
Adds a configuration for key Serializer to the returned builder.
withKeySerializingCopier() - Method in class org.ehcache.config.builders.CacheConfigurationBuilder
Adds by-value semantic using the cache key serializer for the key on heap.
withKeySerializingCopier() - Method in class org.ehcache.config.builders.UserManagedCacheBuilder
Adds a configuration for key copying using the key Serializer to the returned builder.
withLoaderWriter(CacheLoaderWriter<K, V>) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder
Adds a CacheLoaderWriter to the configured builder.
withLoaderWriter(Class<CacheLoaderWriter<K, V>>, Object...) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder
Adds a CacheLoaderWriter configured through a class and optional constructor arguments to the configured builder.
withLoaderWriter(CacheLoaderWriter<K, V>) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder
Adds a CacheLoaderWriter to the returned builder.
withOrderedEventParallelism(int) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder
Adds StoreEventSourceConfiguration with the specified ordered event parallelism to the configured builder.
withOrderedEventParallelism(int) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder
Adds a configuration for the amount of ordered parallelism desired in event processing.
withResourcePools(ResourcePools) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder
Adds the ResourcePools to the returned builder.
withResourcePools(ResourcePoolsBuilder) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder
Convenience method to add a ResourcePools through a ResourcePoolsBuilder to the returned builder.
withResourcePools(ResourcePools) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder
Adds a ResourcePools configuration to the returned builder.
withResourcePools(ResourcePoolsBuilder) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder
Convenience method to add a ResourcePools configuration based on the provided ResourcePoolsBuilder to the returned builder.
withSerializer(Class<C>, Class<? extends Serializer<C>>) - Method in class org.ehcache.config.builders.CacheManagerBuilder
Adds a default Serializer for the specified type to the returned builder.
withSizeOfMaxObjectGraph(long) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder
Adds or updates the DefaultSizeOfEngineConfiguration with the specified object graph maximum size to the configured builder.
withSizeOfMaxObjectGraph(long) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder
Adds or updates the DefaultSizeOfEngineProviderConfiguration with the specified object graph maximum size to the configured builder.
withSizeOfMaxObjectSize(long, MemoryUnit) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder
Adds or updates the DefaultSizeOfEngineConfiguration with the specified maximum mapping size to the configured builder.
withSizeOfMaxObjectSize(long, MemoryUnit) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder
Adds or updates the DefaultSizeOfEngineProviderConfiguration with the specified maximum mapping size to the configured builder.
withValueCopier(Copier<V>) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder
Adds by-value semantic using the provided Copier for the value on heap.
withValueCopier(Class<? extends Copier<V>>) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder
Adds by-value semantic using the provided Copier class for the value on heap.
withValueCopier(Copier<V>) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder
Adds a configuration for value Copier to the returned builder.
withValueSerializer(Serializer<V>) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder
Adds a Serializer for cache values to the configured builder.
withValueSerializer(Class<? extends Serializer<V>>) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder
Adds a Serializer class for cache values to the configured builder.
withValueSerializer(Serializer<V>) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder
Adds a configuration for value Serializer to the returned builder.
withValueSerializingCopier() - Method in class org.ehcache.config.builders.CacheConfigurationBuilder
Adds by-value semantic using the cache value serializer for the value on heap.
withValueSerializingCopier() - Method in class org.ehcache.config.builders.UserManagedCacheBuilder
Adds a configuration for value copying using the key Serializer to the returned builder.
write(K, V) - Method in interface org.ehcache.spi.loaderwriter.CacheLoaderWriter
Writes a single entry to the underlying system of record, maybe a brand new value or an update to an existing value
writeAll(Iterable<? extends Map.Entry<? extends K, ? extends V>>) - Method in interface org.ehcache.spi.loaderwriter.CacheLoaderWriter
Writes multiple entries to the underlying system of record.
WriteBehindConfiguration - Interface in org.ehcache.spi.loaderwriter
WriteBehindConfiguration
WriteBehindConfiguration.BatchingConfiguration - Interface in org.ehcache.spi.loaderwriter
BatchingConfiguration
WriteBehindConfigurationBuilder - Class in org.ehcache.config.builders
The WriteBehindConfigurationBuilder enables building WriteBehindConfigurations using a fluent style.
WriteBehindConfigurationBuilder.BatchedWriteBehindConfigurationBuilder - Class in org.ehcache.config.builders
Specialized WriteBehindConfigurationBuilder for WriteBehindConfigurations that supports batching
WriteBehindConfigurationBuilder.UnBatchedWriteBehindConfigurationBuilder - Class in org.ehcache.config.builders
Specialized WriteBehindConfigurationBuilder for WriteBehindConfigurations without batching support
WriteBehindProvider - Interface in org.ehcache.spi.loaderwriter
 

Z

ZERO - Static variable in class org.ehcache.expiry.Duration
Special Duration value to represent a zero length duration
A B C D E F G H I L M N O P Q R S T U V W Z 
Skip navigation links