A B C D E G I J L M O P R S T U V

A

applicationSetup(String, Function<JvmCacheDetails, JvmCacheSettings>, Function<ExternalCacheDetails, ExternalCacheSettings>) - Method in interface com.atlassian.vcache.internal.VCacheLifecycleManager

To be called when the host application is being setup.

applicationTeardown() - Method in interface com.atlassian.vcache.internal.VCacheLifecycleManager

To be called when the host application is being shutdown.

B

build() - Method in class com.atlassian.vcache.ExternalCacheSettingsBuilder

Returns a new ExternalCacheSettings instance configured using the supplied settings.

build() - Method in class com.atlassian.vcache.JvmCacheSettingsBuilder

Returns a new JvmCacheSettings instance configured using the supplied settings.

C

CacheMetrics - Class in com.atlassian.vcache.internal

To be completed.

CacheMetrics() - Constructor for class com.atlassian.vcache.internal.CacheMetrics

CasIdentifier - Interface in com.atlassian.vcache

Represents an identifier for use in compare-and-swap operations.

ChangeRate - Enum in com.atlassian.vcache

Provides a scale for the rate of change of a measure.

com.atlassian.vcache - package com.atlassian.vcache

Contains the core types for Atlassian VCache API.

com.atlassian.vcache.internal - package com.atlassian.vcache.internal

Contains the Atlassian internal API.

com.atlassian.vcache.marshallers - package com.atlassian.vcache.marshallers

Contains common implementations of the Marshaller interface.

currentRequestCount() - Method in interface com.atlassian.vcache.internal.VCacheLifecycleManager

Returns the current number of requests in progress.

D

dataChangeRateHint(ChangeRate) - Method in class com.atlassian.vcache.ExternalCacheSettingsBuilder

Provides a hint on the expected change rate for data updates.

defaultTtl(Duration) - Method in class com.atlassian.vcache.ExternalCacheSettingsBuilder

Specifies the default time-to-live for entries to be held in the cache.

defaultTtl(Duration) - Method in class com.atlassian.vcache.JvmCacheSettingsBuilder

Specifies the default time-to-live for entries to be held in the cache.

DirectExternalCache<V> - Interface in com.atlassian.vcache

Represents an ExternalCache where all operations are performed directly on the external cache system.

E

entryCountHint(int) - Method in class com.atlassian.vcache.ExternalCacheSettingsBuilder

Provides a hint on the expected number of entries to be held in the cache.

entryGrowthRateHint(ChangeRate) - Method in class com.atlassian.vcache.ExternalCacheSettingsBuilder

Provides a hint on the expected change rate for entry additions.

ExternalCache<V> - Interface in com.atlassian.vcache

Represents an external cache, where the data is ultimately stored in external cache systems like Memcached or Redis.

ExternalCacheDetails - Interface in com.atlassian.vcache.internal

Details for a configured ExternalCache

ExternalCacheDetails.BufferPolicy - Enum in com.atlassian.vcache.internal

Represents the different buffering policies for ExternalCache instances.

ExternalCacheException - Exception in com.atlassian.vcache

Represents a failure occurred with an ExternalCache.

ExternalCacheException(ExternalCacheException.Reason) - Constructor for exception com.atlassian.vcache.ExternalCacheException

Creates an instance for the specified reason.

ExternalCacheException(ExternalCacheException.Reason, Throwable) - Constructor for exception com.atlassian.vcache.ExternalCacheException

Creates an instance for the specified reason and cause.

ExternalCacheException.Reason - Enum in com.atlassian.vcache

The reasons for failure.

ExternalCacheSettings - Class in com.atlassian.vcache

An immutable representation of settings for an ExternalCache.

ExternalCacheSettingsBuilder - Class in com.atlassian.vcache

Builder for creating ExternalCacheSettings instances.

ExternalCacheSettingsBuilder() - Constructor for class com.atlassian.vcache.ExternalCacheSettingsBuilder

Creates an instance with no settings initialised.

ExternalCacheSettingsBuilder(ExternalCacheSettings) - Constructor for class com.atlassian.vcache.ExternalCacheSettingsBuilder

Constructs an instance initialised with the supplied settings.

ExternalWriteOperationsBuffered<V> - Interface in com.atlassian.vcache

Represents the buffered write operations on an ExternalCache.

ExternalWriteOperationsUnbuffered<V> - Interface in com.atlassian.vcache

Represents the unbuffered write operations on an ExternalCache.

G

get(String) - Method in interface com.atlassian.vcache.ExternalCache

Returns a value that is associated with a specified key.

get(String, Supplier<V>) - Method in interface com.atlassian.vcache.ExternalCache

Returns a value that may be associated with a specified key.

get(K) - Method in interface com.atlassian.vcache.LocalCacheOperations

Returns a value that is associated with a specified key.

get(K, Supplier<? extends V>) - Method in interface com.atlassian.vcache.LocalCacheOperations

Returns a value that may be associated with a specified key.

getBulk(String...) - Method in interface com.atlassian.vcache.ExternalCache

Returns the values that are associated with the specified keys.

getBulk(Iterable<String>) - Method in interface com.atlassian.vcache.ExternalCache

Returns the values that are associated with the specified keys.

getBulk(Function<Collection<String>, Map<String, V>>, String...) - Method in interface com.atlassian.vcache.ExternalCache

Returns the values that are associated with the specified keys.

getBulk(Function<Collection<String>, Map<String, V>>, Iterable<String>) - Method in interface com.atlassian.vcache.ExternalCache

Returns the values that are associated with the specified keys.

getBulk(K...) - Method in interface com.atlassian.vcache.LocalCacheOperations

Returns the values that are associated with the specified keys.

getBulk(Iterable<K>) - Method in interface com.atlassian.vcache.LocalCacheOperations

Returns the values that are associated with the specified keys.

getBulk(Function<Collection<K>, Map<K, V>>, K...) - Method in interface com.atlassian.vcache.LocalCacheOperations

Returns the values that are associated with the specified keys.

getBulk(Function<Collection<K>, Map<K, V>>, Iterable<K>) - Method in interface com.atlassian.vcache.LocalCacheOperations

Returns the values that are associated with the specified keys.

getBulkIdentified(String...) - Method in interface com.atlassian.vcache.DirectExternalCache

getBulkIdentified(Iterable<String>) - Method in interface com.atlassian.vcache.DirectExternalCache

getDataChangeRateHint() - Method in class com.atlassian.vcache.ExternalCacheSettings

Returns the hint for the expected change rate for data updates.

getDefaultTtl() - Method in class com.atlassian.vcache.ExternalCacheSettings

Returns the default time-to-live for entries when added.

getDefaultTtl() - Method in class com.atlassian.vcache.JvmCacheSettings

Returns the default time-to-live for entries when added.

getDirectExternalCache(String, Marshaller<V>, ExternalCacheSettings) - Method in interface com.atlassian.vcache.VCacheFactory

Obtains a DirectExternalCache with the specified details.

getEntryCountHint() - Method in class com.atlassian.vcache.ExternalCacheSettings

Returns the hint for the expected number of entries

getEntryGrowthRateHint() - Method in class com.atlassian.vcache.ExternalCacheSettings

Returns the hint for the expected change rate for entry additions.

getExternalDefaults(String) - Method in interface com.atlassian.vcache.internal.VCacheSettingsDefaultsProvider

Obtain the default settings for an ExternalCache.

getIdentified(String) - Method in interface com.atlassian.vcache.DirectExternalCache

Returns an identified value that is associated with a specified key.

getJvmCache(String, JvmCacheSettings) - Method in interface com.atlassian.vcache.VCacheFactory

Obtains a JvmCache with the specified details.

getJvmDefaults(String) - Method in interface com.atlassian.vcache.internal.VCacheSettingsDefaultsProvider

Obtain the default settings for a JvmCache.

getKeys() - Method in interface com.atlassian.vcache.JvmCache

Gets the keys of all objects currently stored in the cache.

getMaxEntries() - Method in class com.atlassian.vcache.JvmCacheSettings

Returns the maximum number of entries allowed.

getName() - Method in interface com.atlassian.vcache.internal.ExternalCacheDetails

The name of the cache, uniquely identifies this cache.

getName() - Method in interface com.atlassian.vcache.internal.JvmCacheDetails

getName() - Method in interface com.atlassian.vcache.internal.RequestCacheDetails

getName() - Method in interface com.atlassian.vcache.VCache

The name of the cache, uniquely identifies this cache.

getPolicy() - Method in interface com.atlassian.vcache.internal.ExternalCacheDetails

getReason() - Method in exception com.atlassian.vcache.ExternalCacheException

Returns the reason for failure.

getRequestCache(String) - Method in interface com.atlassian.vcache.VCacheFactory

Obtains a RequestCache with the specified details.

getSettings() - Method in interface com.atlassian.vcache.internal.ExternalCacheDetails

getSettings() - Method in interface com.atlassian.vcache.internal.JvmCacheDetails

getStableReadExternalCache(String, Marshaller<V>, ExternalCacheSettings) - Method in interface com.atlassian.vcache.VCacheFactory

Obtains a StableReadExternalCache with the specified details.

getTransactionalExternalCache(String, Marshaller<V>, ExternalCacheSettings) - Method in interface com.atlassian.vcache.VCacheFactory

Obtains a TransactionalExternalCache with the specified details.

I

IdentifiedValue<T> - Interface in com.atlassian.vcache

Represents a value that has an associated CasIdentifier that can be used for "compare-and-swap" operations.

identifier() - Method in interface com.atlassian.vcache.IdentifiedValue

Returns the CasIdentifier associated with the value.

isRequestInProgress() - Method in interface com.atlassian.vcache.internal.VCacheLifecycleManager

Returns whether a request is currently in progress for this thread.

J

JvmCache<K,V> - Interface in com.atlassian.vcache

Interface that defines the JVM cache operations.

JvmCacheDetails - Interface in com.atlassian.vcache.internal

Details for a configured JvmCache

JvmCacheSettings - Class in com.atlassian.vcache

An immutable representation of settings for an JvmCache.

JvmCacheSettingsBuilder - Class in com.atlassian.vcache

Builder for creating JvmCacheSettings instances.

JvmCacheSettingsBuilder() - Constructor for class com.atlassian.vcache.JvmCacheSettingsBuilder

Creates an instance with no settings initialised.

JvmCacheSettingsBuilder(JvmCacheSettings) - Constructor for class com.atlassian.vcache.JvmCacheSettingsBuilder

Constructs an instance initialised with the supplied settings.

L

LocalCacheOperations<K,V> - Interface in com.atlassian.vcache

Represents the common operations that can be performed on a JVM local cache.

M

marshall(T) - Method in interface com.atlassian.vcache.Marshaller

Responsible for converting a object into an array of bytes.

Marshaller<T> - Interface in com.atlassian.vcache

Represents the ability to convert an object, of type T, to and from an array of bytes.

MarshallerException - Exception in com.atlassian.vcache

Represents a failure occurred when marshalling data.

MarshallerException(String) - Constructor for exception com.atlassian.vcache.MarshallerException

Creates an instance with the supplied message.

MarshallerException(String, Throwable) - Constructor for exception com.atlassian.vcache.MarshallerException

Creates an instance with the supplied message and causing Throwable.

MarshallerFactory - Class in com.atlassian.vcache.marshallers

Factory for Marshaller instances for common types.

MarshallerFactory() - Constructor for class com.atlassian.vcache.marshallers.MarshallerFactory

maxEntries(int) - Method in class com.atlassian.vcache.JvmCacheSettingsBuilder

Specifies the maximum number of entries to be held in the cache.

O

override(ExternalCacheSettings) - Method in class com.atlassian.vcache.ExternalCacheSettings

Returns a new ExternalCacheSettings instance where the current settings are overridden with settings specified in overrides.

override(JvmCacheSettings) - Method in class com.atlassian.vcache.JvmCacheSettings

Returns a new JvmCacheSettings instance where the current settings are overridden with settings specified in overrides.

P

PartitionAwareVCacheLifecycleManager - Interface in com.atlassian.vcache.internal

The management interface specific for a partition-aware VCacheLifecycleManager.

PartitionlessVCacheLifecycleManager - Interface in com.atlassian.vcache.internal

The management interface specific for a VCacheLifecycleManager which does not partition data.

put(String, V, PutPolicy) - Method in interface com.atlassian.vcache.ExternalWriteOperationsBuffered

Puts the value under the specified key using the specified policy.

put(String, V, PutPolicy) - Method in interface com.atlassian.vcache.ExternalWriteOperationsUnbuffered

Puts the value under the specified key using the specified policy.

put(K, V) - Method in interface com.atlassian.vcache.LocalCacheOperations

Unconditionally puts the value under the specified key, and returns the previous value associated with the key (if one existed).

putIfAbsent(K, V) - Method in interface com.atlassian.vcache.LocalCacheOperations

Conditionally puts the value under the specified key, if no entry currently exists.

PutPolicy - Enum in com.atlassian.vcache

Represents the different policies for a put operation on a cache.

R

remove(String...) - Method in interface com.atlassian.vcache.ExternalWriteOperationsBuffered

Remove the entries with the specified keys.

remove(Iterable<String>) - Method in interface com.atlassian.vcache.ExternalWriteOperationsBuffered

Remove the entries with the specified keys.

remove(String...) - Method in interface com.atlassian.vcache.ExternalWriteOperationsUnbuffered

Remove the entries with the specified keys.

remove(Iterable<String>) - Method in interface com.atlassian.vcache.ExternalWriteOperationsUnbuffered

Remove the entries with the specified keys.

remove(K...) - Method in interface com.atlassian.vcache.LocalCacheOperations

Removes all the entries for the supplied keys.

remove(Iterable<K>) - Method in interface com.atlassian.vcache.LocalCacheOperations

Removes all the entries for the supplied keys.

removeAll() - Method in interface com.atlassian.vcache.ExternalWriteOperationsBuffered

Remove all entries in the cache.

removeAll() - Method in interface com.atlassian.vcache.ExternalWriteOperationsUnbuffered

Remove all entries in the cache.

removeAll() - Method in interface com.atlassian.vcache.LocalCacheOperations

Removes all the entries in the cache.

removeIf(String, CasIdentifier) - Method in interface com.atlassian.vcache.DirectExternalCache

Removes the specified entry, iff the specified CAS identifier matches.

removeIf(K, V) - Method in interface com.atlassian.vcache.LocalCacheOperations

Conditionally removed an entry for a specified key, iff: An entry already exists for the key The current value matches the supplied value using Object.equals(Object)

replaceIf(String, CasIdentifier, V) - Method in interface com.atlassian.vcache.DirectExternalCache

Replaces the value for a specified entry, iff the specified CAS identifier matches.

replaceIf(K, V, V) - Method in interface com.atlassian.vcache.LocalCacheOperations

Conditionally replaces the value associated with a key, iff: An entry already exists for the key The current value matches the supplied currentValue using Object.equals(Object)

RequestCache<K,V> - Interface in com.atlassian.vcache

Represents a request scope cache, which is intended to hold data for the life of a request.

RequestCacheDetails - Interface in com.atlassian.vcache.internal

Details for a configured RequestCache

requestSetup(String) - Method in interface com.atlassian.vcache.internal.PartitionAwareVCacheLifecycleManager

To be called before a thread is about to perform a request (unit of work).

requestSetup() - Method in interface com.atlassian.vcache.internal.PartitionlessVCacheLifecycleManager

To be called before a thread is about to perform a request (unit of work).

requestTeardown() - Method in interface com.atlassian.vcache.internal.VCacheLifecycleManager

To be called after a thread has performed a request (unit of work).

S

serializableMarshaller(Class<T>) - Static method in class com.atlassian.vcache.marshallers.MarshallerFactory

Returns a Marshaller for Serializable objects.

serializableMarshaller(Class<T>, ClassLoader) - Static method in class com.atlassian.vcache.marshallers.MarshallerFactory

Returns a Marshaller for Serializable objects.

StableReadExternalCache<V> - Interface in com.atlassian.vcache

Represents an ExternalCache where the read operations are buffered.

stringMarshaller() - Static method in class com.atlassian.vcache.marshallers.MarshallerFactory

Returns a Marshaller for String objects.

T

TransactionalExternalCache<V> - Interface in com.atlassian.vcache

Represents an ExternalCache where both the read and write operations are buffered until the end of a transaction.

U

unmarshall(byte[]) - Method in interface com.atlassian.vcache.Marshaller

Responsible for converting an array of bytes into an object.

V

value() - Method in interface com.atlassian.vcache.IdentifiedValue

Returns the value.

valueOf(String) - Static method in enum com.atlassian.vcache.ChangeRate

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

valueOf(String) - Static method in enum com.atlassian.vcache.ExternalCacheException.Reason

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

valueOf(String) - Static method in enum com.atlassian.vcache.internal.ExternalCacheDetails.BufferPolicy

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

valueOf(String) - Static method in enum com.atlassian.vcache.PutPolicy

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

values() - Static method in enum com.atlassian.vcache.ChangeRate

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

values() - Static method in enum com.atlassian.vcache.ExternalCacheException.Reason

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

values() - Static method in enum com.atlassian.vcache.internal.ExternalCacheDetails.BufferPolicy

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

values() - Static method in enum com.atlassian.vcache.PutPolicy

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

VCache - Interface in com.atlassian.vcache

Represents the characteristics common to all types of caches.

VCacheFactory - Interface in com.atlassian.vcache

Represents the factory for creating caches.

VCacheLifecycleManager - Interface in com.atlassian.vcache.internal

The lifecyle management interface that contains methods that need to be called, by the host application, at different stages.

VCacheManagement - Interface in com.atlassian.vcache.internal

The management interface that contains methods to obtain information and manage the caches.

VCacheSettingsDefaultsProvider - Interface in com.atlassian.vcache.internal

A manager for retrieving the default settings for caches.

A B C D E G I J L M O P R S T U V