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

A

addCache(Cache<?, ?>) - Method in interface javax.cache.CacheManager

Adds an uninitialised Cache to the CacheManager and starts it.

C

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

A Cache provides temporary storage for later fast retrieval.

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

A cache entry (key-value pair).

CacheBuilder - Interface in javax.cache

A CacheBuilder is used for creating Caches.

CacheConfiguration - Interface in javax.cache

Information on how a cache is configured.

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

CacheKey - Interface in javax.cache.interceptor

A serializable, immutable, thread-safe object that can be used for a cache key.

CacheKeyGenerator - Interface in javax.cache.interceptor

Generates cache keys for intercepted method invocations.

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.

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

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 a specified cache name and 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.

CacheStatisticsMBean - Interface in javax.cache

A management bean for caches.

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

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.

createCache(String) - Method in interface javax.cache.CacheBuilder

Create an instance of the named Cache.

createCache(String, CacheConfiguration) - Method in interface javax.cache.CacheBuilder

Create an instance of the named Cache.

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.

DefaultCacheKey - Class in javax.cache.interceptor

Default cache key implementation.

DefaultCacheKey(Object[]) - Constructor for class javax.cache.interceptor.DefaultCacheKey

Constructs a default cache key

DefaultCacheKeyGenerator - Class in javax.cache.interceptor

Creates a DefaultCacheKey for the InvocationContext.

DefaultCacheKeyGenerator() - Constructor for class javax.cache.interceptor.DefaultCacheKeyGenerator

DefaultCacheResolver - Class in javax.cache.interceptor

Default CacheResolver that uses the default CacheManager, CacheBuilder and finds the Cache using CacheManager.getCache(String), CacheBuilder.createCache(String).

DefaultCacheResolver(CacheManager, CacheBuilder) - Constructor for class javax.cache.interceptor.DefaultCacheResolver

Constructs the resolver

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.

equals(Object) - Method in class javax.cache.interceptor.DefaultCacheKey

G

generateCacheKey(InvocationContext) - Method in interface javax.cache.interceptor.CacheKeyGenerator

Called for each intercepted method invocation.

generateCacheKey(InvocationContext) - Method in class javax.cache.interceptor.DefaultCacheKeyGenerator

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

Gets an entry from the cache.

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

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

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

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

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

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

Looks up a named cache.

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

The total number of evictions from the cache.

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

The total number of requests to the cache.

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

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

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

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

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

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

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

Return the name of the cache.

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

The total number of puts to the cache.

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

The total number of removals from the cache.

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

Returns the CacheStatisticsMBean object associated with the cache.

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

Returns a CacheConfiguration.

getEntryCount() - Method in interface javax.cache.CacheStatisticsMBean

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

Returns the key corresponding to this entry.

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

Get the name of this cache manager

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

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

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

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

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

Returns the cache status.

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

This method will return a UserTransaction.

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

Returns the value corresponding to this entry.

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

hashCode() - Method in class javax.cache.interceptor.DefaultCacheKey

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

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

Whether storeByValue (true) or storeByReference (false)

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

Lifecycle - Interface in javax.cache

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

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

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

load(K, 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).

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

If the specified key is not already associated with a value, associate it with the given value.

R

registerCacheEntryListener(CacheEntryListener, NotificationScope) - Method in interface javax.cache.Cache

Adds a listener to the notification service.

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

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

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

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

resolveCacheManger(String, Method) - Method in interface javax.cache.interceptor.CacheResolver

resolveCacheManger(String, Method) - Method in class javax.cache.interceptor.DefaultCacheResolver

S

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 set on this cache.

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

Sets whether the cache is store-by-value 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.Lifecycle

Notifies providers to start themselves.

Status - Enum in javax.cache

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

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

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.

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

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

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

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

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.

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