Index (Atlassian Cache - API 3.2.0 API)

A B C E F G I L M O P R S U V

A

addListener(CacheEntryListener<K, V>, boolean) - Method in interface com.atlassian.cache.Cache: Deprecated.
since 2.9 may not be supported in all implementations and will be removed after June 2016
addListener(CachedReferenceListener<V>, boolean) - Method in interface com.atlassian.cache.CachedReference: Deprecated.
since 2.9 may not be supported in all implementations

B

build() - Method in class com.atlassian.cache.CacheSettingsBuilder

C

Cache<K,V> - Interface in com.atlassian.cache: Interface that defines the common cache operations.
CachedReference<V> - Interface in com.atlassian.cache: A Resettable reference.
CachedReferenceAdapter<V> - Class in com.atlassian.cache: An abstract adapter for CachedReferenceListener.
CachedReferenceAdapter() - Constructor for class com.atlassian.cache.CachedReferenceAdapter
CachedReferenceEvent<V> - Interface in com.atlassian.cache: A resettable reference event.
CachedReferenceListener<V> - Interface in com.atlassian.cache: A resettable reference listener.
CacheEntryAdapter<K,V> - Class in com.atlassian.cache: An abstract adapter for CacheEntryListener.
CacheEntryAdapter() - Constructor for class com.atlassian.cache.CacheEntryAdapter
CacheEntryEvent<K,V> - Interface in com.atlassian.cache: A cache event.
CacheEntryListener<K,V> - Interface in com.atlassian.cache: A cache listener.
CacheException - Exception in com.atlassian.cache
CacheException() - Constructor for exception com.atlassian.cache.CacheException
CacheException(String, Throwable) - Constructor for exception com.atlassian.cache.CacheException
CacheException(String) - Constructor for exception com.atlassian.cache.CacheException
CacheException(Throwable) - Constructor for exception com.atlassian.cache.CacheException
CacheFactory - Interface in com.atlassian.cache: Interface for creating and/or attaching to caches.
CacheLoader<K,V> - Interface in com.atlassian.cache: Populates a cache, for example lazily upon a miss.
CacheManager - Interface in com.atlassian.cache
CacheSettings - Interface in com.atlassian.cache: An immutable representation of settings for a Cache.
CacheSettingsBuilder - Class in com.atlassian.cache: A builder for creating CacheSettings instances.
CacheSettingsBuilder() - Constructor for class com.atlassian.cache.CacheSettingsBuilder: Constructor
CacheSettingsBuilder(CacheSettings) - Constructor for class com.atlassian.cache.CacheSettingsBuilder: Constructor that initializes the builder with the settings from a CacheSettings instance
CacheSettingsDefaultsProvider - Interface in com.atlassian.cache: A manager for cache settings, providing operations for retrieving and storing settings to persistent storage.
CacheStatisticsKey - Enum in com.atlassian.cache: An immutable representation of a statistics key for a Cache.
clear() - Method in interface com.atlassian.cache.ManagedCache: Clear the cache.
com.atlassian.cache - package com.atlassian.cache
containsKey(K) - Method in interface com.atlassian.cache.Cache: Returns whether an entry exists in the cache under the specified key.
currentExpireAfterAccessMillis() - Method in interface com.atlassian.cache.ManagedCache
currentExpireAfterWriteMillis() - Method in interface com.atlassian.cache.ManagedCache
currentMaxEntries() - Method in interface com.atlassian.cache.ManagedCache

E

expireAfterAccess(long, TimeUnit) - Method in class com.atlassian.cache.CacheSettingsBuilder: Set a hint for the cache regarding how long entries should be held in the cache.
expireAfterWrite(long, TimeUnit) - Method in class com.atlassian.cache.CacheSettingsBuilder: Set a hint for the cache regarding how long entries should be held in the cache.

F

flushable() - Method in class com.atlassian.cache.CacheSettingsBuilder: Indicates that this cache can be flushed by the cache manager when desired.
flushCaches() - Method in interface com.atlassian.cache.CacheManager: Flush the contents of all flushable caches registered with the cache manager.

G

get(K) - Method in interface com.atlassian.cache.Cache: Retrieve an object from this cache.
get(K, Supplier<? extends V>) - Method in interface com.atlassian.cache.Cache: Retrieve an object from this cache.
get() - Method in interface com.atlassian.cache.CachedReference: Get a value from the cache.
get() - Method in interface com.atlassian.cache.Supplier: Produce an object.
getCache(String) - Method in interface com.atlassian.cache.CacheFactory: Returns the cache with the given name, creates it if necessary.
getCache(Class<?>, String) - Method in interface com.atlassian.cache.CacheFactory: Returns the cache with the given name, creates it if necessary.
getCache(String, CacheLoader<K, V>) - Method in interface com.atlassian.cache.CacheFactory: Returns the cache with the given name and loader, creates it if necessary.
getCache(String, CacheLoader<K, V>, CacheSettings) - Method in interface com.atlassian.cache.CacheFactory: Returns the cache with the given name, loader and required cache settings, creates it if necessary.
getCache(String, Class<K>, Class<V>) - Method in interface com.atlassian.cache.CacheFactory: Deprecated.
since 2.0, use getCache(name) instead
getCacheCollector() - Method in interface com.atlassian.cache.ManagedCache: Returns the collector for this cache.
getCachedReference(String, Supplier<V>) - Method in interface com.atlassian.cache.CacheFactory: Returns a Cached Reference, creating it if necessary.
getCachedReference(String, Supplier<V>, CacheSettings) - Method in interface com.atlassian.cache.CacheFactory: Returns a Cached Reference, creating it if necessary.
getCachedReference(Class<?>, String, Supplier<V>) - Method in interface com.atlassian.cache.CacheFactory: Returns a Cached Reference, creating it if necessary.
getCachedReference(Class<?>, String, Supplier<V>, CacheSettings) - Method in interface com.atlassian.cache.CacheFactory: Returns a Cached Reference, creating it if necessary.
getCaches() - Method in interface com.atlassian.cache.CacheManager: Deprecated.
Since 2.0. Use CacheManager.getManagedCaches() instead.
getDefaults(String) - Method in interface com.atlassian.cache.CacheSettingsDefaultsProvider: Obtains the default cache settings.
getExpireAfterAccess() - Method in interface com.atlassian.cache.CacheSettings
getExpireAfterAccess(long) - Method in interface com.atlassian.cache.CacheSettings: Convenience method that returns CacheSettings.getExpireAfterAccess() if it is not null, otherwise returns the supplied defaultValue.
getExpireAfterWrite() - Method in interface com.atlassian.cache.CacheSettings
getExpireAfterWrite(long) - Method in interface com.atlassian.cache.CacheSettings: Convenience method that returns CacheSettings.getExpireAfterWrite() if it is not null, otherwise returns the supplied defaultValue.
getFlushable() - Method in interface com.atlassian.cache.CacheSettings
getFlushable(boolean) - Method in interface com.atlassian.cache.CacheSettings: Convenience method that returns CacheSettings.getFlushable() if it is not null, otherwise returns the supplied defaultValue.
getKey() - Method in interface com.atlassian.cache.CacheEntryEvent: Returns the key the event was fired for
getKeys() - Method in interface com.atlassian.cache.Cache: Gets the keys of all objects currently stored in the cache.
getLabel() - Method in enum com.atlassian.cache.CacheStatisticsKey: Returns the label for this cache statistics key.
getLocal() - Method in interface com.atlassian.cache.CacheSettings
getLocal(boolean) - Method in interface com.atlassian.cache.CacheSettings: Convenience method that returns CacheSettings.getLocal() if it is not null, otherwise returns the supplied defaultValue.
getManagedCache(String) - Method in interface com.atlassian.cache.CacheManager: Returns the managed cache for the specified name.
getManagedCaches() - Method in interface com.atlassian.cache.CacheManager: Gets the collection of caches managed.
getMaxEntries() - Method in interface com.atlassian.cache.CacheSettings
getMaxEntries(int) - Method in interface com.atlassian.cache.CacheSettings: Convenience method that returns CacheSettings.getMaxEntries() if it is not null, otherwise returns the supplied defaultValue.
getName() - Method in interface com.atlassian.cache.Cache: The name of the cache, uniquely identifies this cache.
getName() - Method in interface com.atlassian.cache.ManagedCache: The name of the cache, uniquely identifies this cache.
getOldValue() - Method in interface com.atlassian.cache.CacheEntryEvent: Returns the old value for this key
getReplicateAsynchronously() - Method in interface com.atlassian.cache.CacheSettings
getReplicateAsynchronously(boolean) - Method in interface com.atlassian.cache.CacheSettings: Convenience method that returns CacheSettings.getReplicateAsynchronously() if it is not null, otherwise returns the supplied defaultValue.
getReplicateViaCopy() - Method in interface com.atlassian.cache.CacheSettings
getReplicateViaCopy(boolean) - Method in interface com.atlassian.cache.CacheSettings: Convenience method that returns CacheSettings.getReplicateViaCopy() if it is not null, otherwise returns the supplied defaultValue.
getStatistics() - Method in interface com.atlassian.cache.ManagedCache: Get usage statistics for the cache.
getStatisticsEnabled() - Method in interface com.atlassian.cache.CacheSettings
getStatisticsEnabled(boolean) - Method in interface com.atlassian.cache.CacheSettings: Convenience method that returns CacheSettings.getStatisticsEnabled() ()} if it is not null, otherwise returns the supplied defaultValue.
getType() - Method in enum com.atlassian.cache.CacheStatisticsKey: Returns the type of statistic that this is.
getValue() - Method in interface com.atlassian.cache.CachedReferenceEvent: Returns cached reference value
getValue() - Method in interface com.atlassian.cache.CacheEntryEvent: Returns the current value for this key

I

isFlushable() - Method in interface com.atlassian.cache.ManagedCache: Returns true if this cache can be safely flushed any time.
isLocal() - Method in interface com.atlassian.cache.ManagedCache
isReplicateAsynchronously() - Method in interface com.atlassian.cache.ManagedCache
isReplicateViaCopy() - Method in interface com.atlassian.cache.ManagedCache
isStatisticsEnabled() - Method in interface com.atlassian.cache.ManagedCache

L

load(K) - Method in interface com.atlassian.cache.CacheLoader: Loads the value for the given key.
local() - Method in class com.atlassian.cache.CacheSettingsBuilder: Indicates that this cache should be local to the node (JVM) where the cache is created.

M

ManagedCache - Interface in com.atlassian.cache: Interface that managed cache things need to implement
maxEntries(int) - Method in class com.atlassian.cache.CacheSettingsBuilder: Indicates that this cache can have a maximum number of entries.

O

onAdd(CacheEntryEvent<K, V>) - Method in class com.atlassian.cache.CacheEntryAdapter
onAdd(CacheEntryEvent<K, V>) - Method in interface com.atlassian.cache.CacheEntryListener: Invoked when a key-value was added to the cache
onEvict(CachedReferenceEvent<V>) - Method in class com.atlassian.cache.CachedReferenceAdapter
onEvict(CachedReferenceEvent<V>) - Method in interface com.atlassian.cache.CachedReferenceListener: Invoked when the cached reference was evicted
onEvict(CacheEntryEvent<K, V>) - Method in class com.atlassian.cache.CacheEntryAdapter
onEvict(CacheEntryEvent<K, V>) - Method in interface com.atlassian.cache.CacheEntryListener: Invoked when a key-value was evicted from the cache
onRemove(CacheEntryEvent<K, V>) - Method in class com.atlassian.cache.CacheEntryAdapter
onRemove(CacheEntryEvent<K, V>) - Method in interface com.atlassian.cache.CacheEntryListener: Invoked when a key-value was removed from the cache
onReset(CachedReferenceEvent<V>) - Method in class com.atlassian.cache.CachedReferenceAdapter
onReset(CachedReferenceEvent<V>) - Method in interface com.atlassian.cache.CachedReferenceListener: Invoked when the cached reference was reset
onSet(CachedReferenceEvent<V>) - Method in class com.atlassian.cache.CachedReferenceAdapter
onSet(CachedReferenceEvent<V>) - Method in interface com.atlassian.cache.CachedReferenceListener: Invoked when the cached reference was set, e.g.
onUpdate(CacheEntryEvent<K, V>) - Method in class com.atlassian.cache.CacheEntryAdapter
onUpdate(CacheEntryEvent<K, V>) - Method in interface com.atlassian.cache.CacheEntryListener: Invoked when key-value was changed in the cache
override(CacheSettings) - Method in interface com.atlassian.cache.CacheSettings: Returns a new CacheSettings instance where the current settings are overridden with settings specified in overrides.

P

put(K, V) - Method in interface com.atlassian.cache.Cache: Put an object into the cache.
putIfAbsent(K, V) - Method in interface com.atlassian.cache.Cache: Atomically associates the specified key with the given value if it is not already associated with a value.

R

remote() - Method in class com.atlassian.cache.CacheSettingsBuilder: Indicates that this cache should be clustered in a clustered deployment.
remove(K) - Method in interface com.atlassian.cache.Cache: Remove the object identified by the key from the cache.
remove(K, V) - Method in interface com.atlassian.cache.Cache: Atomically removes the entry for a key only if currently mapped to a given value.
removeAll() - Method in interface com.atlassian.cache.Cache: Remove all of the objects from this cache.
removeListener(CacheEntryListener<K, V>) - Method in interface com.atlassian.cache.Cache: Deprecated.
since 2.9 may not be supported in all implementations and will be removed after June 2016
removeListener(CachedReferenceListener<V>) - Method in interface com.atlassian.cache.CachedReference: Deprecated.
since 2.9 may not be supported in all implementations
replace(K, V, V) - Method in interface com.atlassian.cache.Cache: Atomically replaces the entry for a key only if currently mapped to a given value.
replicateAsynchronously() - Method in class com.atlassian.cache.CacheSettingsBuilder: Indicates that in a clustered environment with replicated caches, this cache should replicate asynchronously.
replicateSynchronously() - Method in class com.atlassian.cache.CacheSettingsBuilder: Indicates that in a clustered environment with replicated caches, this cache should replicate synchronously.
replicateViaCopy() - Method in class com.atlassian.cache.CacheSettingsBuilder: Indicates that in a clustered environment with replicated caches, this cache should replicate put and update operations by copying the relevant key and value across the wire (requiring both of them to be Serializable).
replicateViaInvalidation() - Method in class com.atlassian.cache.CacheSettingsBuilder: Indicates that in a clustered environment with replicated caches, this cache should replicate by sending only the key across the wire, for invalidation by the other nodes in the cluster; this requires only the key to be Serializable.
reset() - Method in interface com.atlassian.cache.CachedReference: Resets (clears/invalidates) this reference.

S

setStatistics(boolean) - Method in interface com.atlassian.cache.ManagedCache: Deprecated.
Use CacheCollector.setEnabled(boolean) instead for memory caches. This method was never implemented for other cache types.
shutdown() - Method in interface com.atlassian.cache.CacheManager: Shuts down and clean all data of the current instance and its all caches.
SORT_BY_LABEL - Static variable in enum com.atlassian.cache.CacheStatisticsKey: Sorts cache statistics keys by label.
statisticsDisabled() - Method in class com.atlassian.cache.CacheSettingsBuilder: Indicates that this cache should not record statistics.
statisticsEnabled() - Method in class com.atlassian.cache.CacheSettingsBuilder: Indicates that this cache should record statistics.
StatisticsType - Enum in com.atlassian.cache
Supplier<T> - Interface in com.atlassian.cache: Supplier for a single object

U

unflushable() - Method in class com.atlassian.cache.CacheSettingsBuilder: Indicates that this cache cannot be flushed by the cache manager when desired.
updateExpireAfterAccess(long, TimeUnit) - Method in interface com.atlassian.cache.ManagedCache: Attempts to update the hint regarding how long entries that should be held in the cache, after last access.
updateExpireAfterWrite(long, TimeUnit) - Method in interface com.atlassian.cache.ManagedCache: Attempts to update the hint regarding how long entries that should be held in the cache, after last write.
updateMaxEntries(int) - Method in interface com.atlassian.cache.ManagedCache: Attempts to update the hint regarding the maximum number of entries that should be cached at any time.

V

valueOf(String) - Static method in enum com.atlassian.cache.CacheStatisticsKey: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.atlassian.cache.StatisticsType: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.atlassian.cache.CacheStatisticsKey: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.atlassian.cache.StatisticsType: Returns an array containing the constants of this enum type, in the order they are declared.

A B C E F G I L M O P R S U V