B C D E G H I J L N O P R S U V W

B

build() - Method in interface javax.cache.CacheBuilder

Create an instance of the named Cache.

C

Cache<K,V> - Interface in javax.cache

A Cache provides storage of data for later fast retrieval.

Cache.Entry<K,V> - Interface in javax.cache

A cache entry (key-value pair).

CacheBuilder<K,V> - Interface in javax.cache

A CacheBuilder is used for creating Caches.

CacheConfiguration - Interface in javax.cache

Information on how a cache is configured.

CacheDefaults - Annotation Type in javax.cache.interceptor

Allows the configuration of cacheName, cacheResolver and cacheKeyResolver at the class level.

CacheEntryCreatedListener<K,V> - Interface in javax.cache.event

Invoked if a cache entry is created, for example through a Cache.put(Object, Object) operation.

CacheEntryExpiredListener<K,V> - Interface in javax.cache.event

Invoked if a cache entry is removed, for example through a Cache.remove(Object) call.

CacheEntryListener<K,V> - Interface in javax.cache.event

Tagging interface for cache entry listeners.

CacheEntryReadListener<K,V> - Interface in javax.cache.event

Invoked if a cache entry is read, for example through a Cache.get(Object) call.

CacheEntryRemovedListener<K,V> - Interface in javax.cache.event

Invoked if a cache entry is removed, for example through a Cache.remove(Object) call.

CacheEntryUpdatedListener<K,V> - Interface in javax.cache.event

Invoked if an existing cache entry is updated, for example through a Cache.put(Object, Object) operation.

CacheException - Exception in javax.cache

Thrown to indicate an exception has occurred in the Cache.

CacheException() - Constructor for exception javax.cache.CacheException

Constructs a new CacheException.

CacheException(String) - Constructor for exception javax.cache.CacheException

Constructs a new CacheException with a message string.

CacheException(String, Throwable) - Constructor for exception javax.cache.CacheException

Constructs a CacheException with a message string, and a base exception

CacheException(Throwable) - Constructor for exception javax.cache.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).

CacheInvocationContext<A extends Annotation> - Interface in javax.cache.interceptor

Runtime information about an intercepted method invocation for a method annotated with CacheResult, CachePut, CacheRemoveEntry, or CacheRemoveAll

Used with CacheResolver.resolveCache(CacheInvocationContext) to determine the Cache to use at runtime for the method invocation.

CacheInvocationParameter - Interface in javax.cache.interceptor

A parameter to an intercepted method invocation.

CacheKey - Interface in javax.cache.interceptor

A Serializable, immutable, thread-safe object that is used as a cache key.

CacheKeyGenerator - Interface in javax.cache.interceptor

Generates a CacheKey based on a CacheKeyInvocationContext.

CacheKeyInvocationContext<A extends Annotation> - Interface in javax.cache.interceptor

Runtime information about an intercepted method invocation for a method annotated with CacheResult, CachePut, or CacheRemoveEntry.

CacheKeyParam - Annotation Type in javax.cache.interceptor

Marks a method argument as part of the cache key.

CacheLifecycle - Interface in javax.cache

Cache resources may have non-trivial initialisation and disposal procedures.

CacheLoader<K,V> - Interface in javax.cache

Used for read-through caching and loading data into a cache.

CacheManager - Interface in javax.cache

A CacheManager is used for looking up Caches and controls their lifecycle.

CacheManagerFactory - Enum in javax.cache

A factory for creating CacheManagers using the SPI conventions in the JDK's ServiceLoader For a provider to be discovered by the CacheManagerFactory, it's jar must contain a resource called:

CacheManagerFactoryProvider - Interface in javax.cache.spi

Interface that should be implemented by a CacheManager factory provider.

CacheMethodDetails<A extends Annotation> - Interface in javax.cache.interceptor

Static information about a method annotated with one of: CacheResult, CachePut, CacheRemoveEntry, or CacheRemoveAll

Used with CacheResolverFactory.getCacheResolver(CacheMethodDetails) to determine the CacheResolver to use with the method.

CachePut - Annotation Type in javax.cache.interceptor

When a method annotated with CachePut is invoked a CacheKey will be generated and Cache.put(Object, Object) will be invoked on the specified cache storing the value marked with CacheValue.

CacheRemoveAll - Annotation Type in javax.cache.interceptor

When a method annotated with CacheRemoveAll is invoked all elements in the specified cache will be removed via the Cache.removeAll() method

Example of removing all Domain objects from the "domainCache".

CacheRemoveEntry - Annotation Type in javax.cache.interceptor

When a method annotated with CacheRemoveEntry is invoked a CacheKey will be generated and Cache.remove(Object) will be invoked on the specified cache.

CacheResolver - Interface in javax.cache.interceptor

Determines the Cache to use for an intercepted method invocation.

CacheResolverFactory - Interface in javax.cache.interceptor

Determines the CacheResolver to use for an annotated method.

CacheResult - Annotation Type in javax.cache.interceptor

When a method annotated with CacheResult is invoked a CacheKey will be generated and Cache.get(Object) is called before the invoked method actually executes.

CacheStatistics - Interface in javax.cache

A management bean for cache statistics.

CacheStatus - Enum in javax.cache

Indicates the status in it's lifecycle of a resource.

CacheValue - Annotation Type in javax.cache.interceptor

Marks a method argument as the object to cache for a method annotated with CachePut

CacheWriter<K,V> - Interface in javax.cache

A CacheWriter is used for write-through and write-behind caching to a underlying resource.

clearStatistics() - Method in interface javax.cache.CacheStatistics

Clears the statistics counters to 0 for the associated Cache.

containsKey(Object) - Method in interface javax.cache.Cache

Returns true if this cache contains a mapping for the specified key.

createBinary(V) - Method in interface javax.cache.Serializer

Convert a value to a binary.

createCacheBuilder(String) - Method in interface javax.cache.CacheManager

Creates a new CacheBuilder for the named cache to be managed by this cache manager.

createCacheConfiguration() - Method in interface javax.cache.CacheManager

Create a mutable CacheConfiguration instance.

createCacheManager(String) - Method in interface javax.cache.spi.CacheManagerFactoryProvider

Called by the CacheManagerFactory class when a new CacheManager needs to be created.

D

DEFAULT_CACHE_MANAGER_NAME - Static variable in enum javax.cache.CacheManagerFactory

The name of the default cache manager.

delete(Cache.Entry<K, V>) - Method in interface javax.cache.CacheWriter

Delete the cache entry from the store

deleteAll(Collection<Cache.Entry<? extends K, ? extends V>>) - Method in interface javax.cache.CacheWriter

Remove data and keys from the underlying store for the given collection of keys, if present.

E

equals(Object) - Method in interface javax.cache.Cache.Entry

Compares the specified object with this entry for equality.

equals(Object) - Method in interface javax.cache.interceptor.CacheKey

Compare this CacheKey with another.

G

generateCacheKey(CacheKeyInvocationContext<Annotation>) - Method in interface javax.cache.interceptor.CacheKeyGenerator

Called for each intercepted method invocation.

get(Object) - Method in interface javax.cache.Cache

Gets an entry from the cache.

get() - Method in interface javax.cache.Serializer.Binary

Get the stored value

getAll(Collection<? extends K>) - Method in interface javax.cache.Cache

The getAll method will return, from the cache, a Map of the objects associated with the Collection of keys in argument "keys".

getAllParameters() - Method in interface javax.cache.interceptor.CacheInvocationContext

Returns a clone of the array of all method parameters.

getAndPut(K, V) - Method in interface javax.cache.Cache

Atomically associates the specified value with the specified key in this cache

If the cache previously contained a mapping for the key, the old value is replaced by the specified value.

getAndRemove(Object) - Method in interface javax.cache.Cache

Atomically removes the entry for a key only if currently mapped to a given value.

getAndReplace(K, V) - Method in interface javax.cache.Cache

Atomically replaces the entry for a key only if currently mapped to some value.

getAnnotations() - Method in interface javax.cache.interceptor.CacheInvocationParameter

getAnnotations() - Method in interface javax.cache.interceptor.CacheMethodDetails

An immutable Set of all Annotations on this method

getAverageGetMillis() - Method in interface javax.cache.CacheStatistics

The mean time to execute gets.

getAveragePutMillis() - Method in interface javax.cache.CacheStatistics

The mean time to execute puts.

getAverageRemoveMillis() - Method in interface javax.cache.CacheStatistics

The mean time to execute removes.

getBaseType() - Method in interface javax.cache.interceptor.CacheInvocationParameter

The Class.getGenericSuperclass() value of the parameter type declared on the method.

getCache(String) - Method in interface javax.cache.CacheManager

Looks up a named cache.

getCacheAnnotation() - Method in interface javax.cache.interceptor.CacheMethodDetails

The caching related annotation on the method.

getCacheEvictions() - Method in interface javax.cache.CacheStatistics

The total number of evictions from the cache.

getCacheGets() - Method in interface javax.cache.CacheStatistics

The total number of requests to the cache.

getCacheHitPercentage() - Method in interface javax.cache.CacheStatistics

CacheStatistics.getCacheHits() divided by the total number of gets.

getCacheHits() - Method in interface javax.cache.CacheStatistics

The number of get requests that were satisfied by the cache.

getCacheManager() - Method in interface javax.cache.Cache

Gets the CacheManager managing this cache.

getCacheManager() - Method in enum javax.cache.CacheManagerFactory

Get the default cache manager.

getCacheManager(String) - Method in enum javax.cache.CacheManagerFactory

Get a named cache manager.

getCacheMisses() - Method in interface javax.cache.CacheStatistics

A miss is a get request which is not satisfied.

getCacheMissPercentage() - Method in interface javax.cache.CacheStatistics

Returns the percentage of cache accesses that did not find a requested entry in the cache.

getCacheName() - Method in interface javax.cache.interceptor.CacheMethodDetails

The cache name resolved by the implementation, this may not match the cache name specified in the caching annotation on this method.

getCachePuts() - Method in interface javax.cache.CacheStatistics

The total number of puts to the cache.

getCacheRemovals() - Method in interface javax.cache.CacheStatistics

The total number of removals from the cache.

getCacheResolver(CacheMethodDetails<? extends Annotation>) - Method in interface javax.cache.interceptor.CacheResolverFactory

Get the CacheResolver used for runtime resolution of the Cache used by the CacheResult, CachePut, CacheRemoveEntry, or CacheRemoveAll interceptors.

getCaches() - Method in interface javax.cache.CacheManager

Returns a collection of caches managed by this CacheManager

getConfiguration() - Method in interface javax.cache.Cache

Returns a CacheConfiguration.

getKey() - Method in interface javax.cache.Cache.Entry

Returns the key corresponding to this entry.

getKeyParameters() - Method in interface javax.cache.interceptor.CacheKeyInvocationContext

Returns a clone of the array of all method parameters to be used by the CacheKeyGenerator in creating a CacheKey.

getMethod() - Method in interface javax.cache.interceptor.CacheMethodDetails

The annotated method

getName() - Method in interface javax.cache.Cache

Return the name of the cache.

getName() - Method in interface javax.cache.CacheManager

Get the name of this cache manager

getName() - Method in interface javax.cache.CacheStatistics

getNotificationScope() - Method in interface javax.cache.event.CacheEntryListener

getParameterPosition() - Method in interface javax.cache.interceptor.CacheInvocationParameter

The index of the parameter in the original parameter array as returned by CacheInvocationContext.getAllParameters()

getRawType() - Method in interface javax.cache.interceptor.CacheInvocationParameter

The parameter type as declared on the method.

getStatistics() - Method in interface javax.cache.Cache

Returns the CacheStatistics MXBean associated with the cache.

getStatus() - Method in interface javax.cache.CacheLifecycle

Returns the cache status.

getStatus() - Method in interface javax.cache.CacheStatistics

Gets the CacheStatus attribute of the Cache expressed as a String.

getTarget() - Method in interface javax.cache.interceptor.CacheInvocationContext

getUserTransaction() - Method in interface javax.cache.CacheManager

This method will return a UserTransaction.

getValue() - Method in interface javax.cache.Cache.Entry

Returns the value stored in the cache when this entry was created.

getValue() - Method in interface javax.cache.interceptor.CacheInvocationParameter

getValueParameter() - Method in interface javax.cache.interceptor.CacheKeyInvocationContext

When a method is annotated with CachePut one parameter is the value to be cached.

H

hashCode() - Method in interface javax.cache.Cache.Entry

Returns the hash code value for this cache entry.

hashCode() - Method in interface javax.cache.interceptor.CacheKey

The immutable hash code of the cache key.

I

InvalidConfigurationException - Exception in javax.cache

An exception to report invalid configuration settings.

InvalidConfigurationException() - Constructor for exception javax.cache.InvalidConfigurationException

isReadThrough() - Method in interface javax.cache.CacheConfiguration

Whether the cache is a read-through cache.

isStatisticsEnabled() - Method in interface javax.cache.CacheConfiguration

Checks whether statistics collection is enabled in this cache.

isStoreByValue() - Method in interface javax.cache.CacheConfiguration

Whether storeByValue (true) or storeByReference (false).

isSupported(OptionalFeature) - Method in enum javax.cache.CacheManagerFactory

Indicates whether a optional feature is supported by this implementation

isSupported(OptionalFeature) - Method in interface javax.cache.spi.CacheManagerFactoryProvider

Indicates whether a optional feature is supported by this implementation

isTransactionEnabled() - Method in interface javax.cache.CacheConfiguration

Checks whether transactions are enabled for this cache.

isWriteThrough() - Method in interface javax.cache.CacheConfiguration

Whether the cache is a write-through cache.

J

javax.cache - package javax.cache

This package contains the API for JCache..

javax.cache.event - package javax.cache.event

This package contains listeners and scoping interfaces.

javax.cache.interceptor - package javax.cache.interceptor

This package contains annotations for adding caching interceptors to POJOs.

javax.cache.spi - package javax.cache.spi

The javax.cache.spi package defines the classes and interfaces that are implemented by the persistence provider for use by the CacheManagerFactory class

L

load(K, CacheLoader<K, V>, Object) - Method in interface javax.cache.Cache

The load method provides a means to "pre load" the cache.

load(Object, Object) - Method in interface javax.cache.CacheLoader

loads an object.

loadAll(Collection<? extends K>, CacheLoader<K, V>, Object) - Method in interface javax.cache.Cache

The loadAll method provides a means to "pre load" objects into the cache.

loadAll(Collection<? extends K>, Object) - Method in interface javax.cache.CacheLoader

loads multiple object.

N

NotificationScope - Enum in javax.cache.event

This enumeration defines valid values for CacheEntryListener notification scope.

O

onCreate(Cache.Entry<K, V>) - Method in interface javax.cache.event.CacheEntryCreatedListener

Called after the entry has been created (put into the cache where no previous mapping existed).

onCreateAll(Iterable<Cache.Entry<K, V>>) - Method in interface javax.cache.event.CacheEntryCreatedListener

Called after the entries have been created (put into the cache where no previous mapping existed).

onExpire(Cache.Entry<K, V>) - Method in interface javax.cache.event.CacheEntryExpiredListener

Called after the entry has expired and has thus been removed from the Cache.

onRead(Cache.Entry<K, V>) - Method in interface javax.cache.event.CacheEntryReadListener

Called after the entry has been read.

onReadAll(Iterable<Cache.Entry<K, V>>) - Method in interface javax.cache.event.CacheEntryReadListener

Called after the entries have been read.

onRemove(Cache.Entry<K, V>) - Method in interface javax.cache.event.CacheEntryRemovedListener

Called after the entry has been removed.

onRemoveAll(Iterable<Cache.Entry<K, V>>) - Method in interface javax.cache.event.CacheEntryRemovedListener

Called after the entries have been removed by a batch operation.

onUpdate(Cache.Entry<K, V>) - Method in interface javax.cache.event.CacheEntryUpdatedListener

Called after the entry has been updated (put into the cache where a previous mapping existed).

onUpdateAll(Iterable<Cache.Entry<K, V>>) - Method in interface javax.cache.event.CacheEntryUpdatedListener

Called after the entries have been updated (put into the cache where a previous mapping existed).

OptionalFeature - Enum in javax.cache

Optional features that may be present in an implementation.

P

put(K, V) - Method in interface javax.cache.Cache

Associates the specified value with the specified key in this cache If the cache previously contained a mapping for the key, the old value is replaced by the specified value.

putAll(Map<? extends K, ? extends V>) - Method in interface javax.cache.Cache

Copies all of the mappings from the specified map to this cache.

putIfAbsent(K, V) - Method in interface javax.cache.Cache

Atomically associates the specified key with the given value if it is not already associated with a value.

R

registerCacheEntryListener(CacheEntryListener<K, V>, NotificationScope, boolean) - Method in interface javax.cache.Cache

Adds a listener to the notification service.

registerCacheEntryListener(CacheEntryListener<K, V>, NotificationScope, boolean) - Method in interface javax.cache.CacheBuilder

Registers a listener.

remove(Object) - Method in interface javax.cache.Cache

Removes the mapping for a key from this cache if it is present.

removeAll(Collection<? extends K>) - Method in interface javax.cache.Cache

Removes entries for the specified keys

removeAll() - Method in interface javax.cache.Cache

Removes all of the mappings from this cache.

removeCache(String) - Method in interface javax.cache.CacheManager

Remove a cache from the CacheManager.

replace(K, V, V) - Method in interface javax.cache.Cache

Atomically replaces the entry for a key only if currently mapped to a given value.

replace(K, V) - Method in interface javax.cache.Cache

Atomically replaces the entry for a key only if currently mapped to some value.

resolveCache(CacheInvocationContext<Annotation>) - Method in interface javax.cache.interceptor.CacheResolver

Resolve the Cache to use for this CacheInvocationContext.

S

Serializer<V> - Interface in javax.cache

Tagging interface for a binary representation of a value or key.

Serializer.Binary<V> - Interface in javax.cache

Internal storage

setCacheConfiguration(CacheConfiguration) - Method in interface javax.cache.CacheBuilder

Set the cache configuration.

setCacheLoader(CacheLoader<K, V>) - Method in interface javax.cache.CacheBuilder

Set the cache loader.

setReadThrough(boolean) - Method in interface javax.cache.CacheConfiguration

Sets whether the cache is a read-through cache.

setStatisticsEnabled(boolean) - Method in interface javax.cache.CacheConfiguration

Sets whether statistics gathering is enabled on this cache.

setStoreByValue(boolean) - Method in interface javax.cache.CacheConfiguration

Sets whether the cache is store-by-value cache.

setTransactionEnabled(boolean) - Method in interface javax.cache.CacheConfiguration

Sets whether transactions are enabled for this cache

setWriteThrough(boolean) - Method in interface javax.cache.CacheConfiguration

Whether the cache is a write-through cache.

shouldDeliver(boolean) - Method in enum javax.cache.event.NotificationScope

Determine whether an event should be delivered under this notification scope.

shutdown() - Method in interface javax.cache.CacheManager

Shuts down the CacheManager.

start() - Method in interface javax.cache.CacheLifecycle

Notifies providers to start themselves.

statsAccumulatingFrom() - Method in interface javax.cache.CacheStatistics

The date from which statistics have been accumulated.

stop() - Method in interface javax.cache.CacheLifecycle

Providers may be doing all sorts of exotic things and need to be able to clean up on stop.

U

unregisterCacheEntryListener(CacheEntryListener<?, ?>) - Method in interface javax.cache.Cache

Removes a call back listener.

unwrap(Class<T>) - Method in interface javax.cache.interceptor.CacheInvocationContext

Return an object of the specified type to allow access to the provider-specific API.

V

valueOf(String) - Static method in enum javax.cache.CacheManagerFactory

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum javax.cache.CacheStatus

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum javax.cache.event.NotificationScope

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum javax.cache.OptionalFeature

Returns the enum constant of this type with the specified name.

values() - Static method in enum javax.cache.CacheManagerFactory

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum javax.cache.CacheStatus

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum javax.cache.event.NotificationScope

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum javax.cache.OptionalFeature

Returns an array containing the constants of this enum type, in the order they are declared.

W

write(Cache.Entry<K, V>) - Method in interface javax.cache.CacheWriter

Write the specified value under the specified key to the underlying store.

writeAll(Collection<Cache.Entry<? extends K, ? extends V>>) - Method in interface javax.cache.CacheWriter

Write the specified entries to the underlying store.

B C D E G H I J L N O P R S U V W