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

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.

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

Returns a new RequestCacheSettings instance configured using the supplied settings.

C

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.marshallers - package com.atlassian.vcache.marshallers

Contains common implementations of the Marshaller interface.

D

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

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

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

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 and must be a positive number.

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

Specifies the default time-to-live for entries to be held in the cache and must be a positive number.

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.

equals(Object) - Method in interface com.atlassian.vcache.CasIdentifier

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.

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.

F

fold(CompletionStage<T>, Function<T, R>, Function<Throwable, R>) - Static method in class com.atlassian.vcache.VCacheUtils

Syntactic sugar for handling the result (either success or failure) from a CompletionStage.

fold(CompletionStage<T>, BiFunction<T, Throwable, R>) - Static method in class com.atlassian.vcache.VCacheUtils

Syntactic sugar for writing stage.handle(fn).toCompletableFuture().unsafeJoin().

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<Set<String>, Map<String, V>>, String...) - Method in interface com.atlassian.vcache.ExternalCache

Returns the values that are associated with the specified keys.

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

Returns the values that are associated with the specified keys.

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

Returns the values that are associated with the specified keys.

getBulk(Function<Set<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

Returns the IdentifiedValue's that are associated with the specified keys.

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

Returns the IdentifiedValue's that are associated with the specified keys.

getChangeRate() - Method in class com.atlassian.vcache.RequestCacheSettings

Returns the expected change rate for this cache.

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

Deprecated.

since 1.5.0. Use VCacheFactory.getDirectExternalCache(String, MarshallingPair, ExternalCacheSettings)

getDirectExternalCache(String, MarshallingPair<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.

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

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

getIdentified(String, Supplier<V>) - 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.

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

The name of the cache, uniquely identifies this cache.

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

Returns the reason for failure.

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

Deprecated.

Please use VCacheFactory.getRequestCache(String, RequestCacheSettings) instead.

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

Obtains a RequestCache with the specified settings.

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

Deprecated.

since 1.5.0. Use VCacheFactory.getStableReadExternalCache(String, MarshallingPair, ExternalCacheSettings)

getStableReadExternalCache(String, MarshallingPair<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

Deprecated.

since 1.5.0. Use VCacheFactory.getTransactionalExternalCache(String, MarshallingPair, ExternalCacheSettings)

getTransactionalExternalCache(String, MarshallingPair<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.

J

join(CompletionStage<V>) - Static method in class com.atlassian.vcache.VCacheUtils

Deprecated.

since 1.5.0 - use VCacheUtils.unsafeJoin(CompletionStage) instead (if you must).

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

Interface that defines the JVM cache operations.

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

Deprecated.

Responsible for converting a object into an array of bytes.

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

Deprecated.

since 1.5.0. Use the Atlassian Marshalling API and implementations instead.

MarshallerException - Exception in com.atlassian.vcache

Deprecated.

since 1.5.0. Use the Atlassian Marshalling API and implementations instead.

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

Deprecated.

Creates an instance with the supplied message.

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

Deprecated.

Creates an instance with the supplied message and causing Throwable.

MarshallerFactory - Class in com.atlassian.vcache.marshallers

Deprecated.

since 1.5.0. Use the Atlassian Marshalling API and implementations instead.

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

Deprecated.

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

Deprecated.

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

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

O

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

Deprecated.

Returns a Marshaller for Optional objects.

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

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.

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 the entries for the supplied key.

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.

RequestCacheSettings - Class in com.atlassian.vcache

Settings for configuring a RequestCache.

RequestCacheSettingsBuilder - Class in com.atlassian.vcache

Builder for creating RequestCacheSettings instances.

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

S

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

Deprecated.

Returns a Marshaller for Serializable objects.

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

Deprecated.

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

Deprecated.

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

Deprecated.

Responsible for converting an array of bytes into an object.

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

Deprecated.

unsafeJoin(CompletionStage<V>) - Static method in class com.atlassian.vcache.VCacheUtils

Syntactic sugar for writing stage.toCompletableFuture().unsafeJoin().

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

VCacheException - Exception in com.atlassian.vcache

Represents a failure occurred when using the VCache API.

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

Creates an instance with the supplied message.

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

Creates an instance with the supplied message and cause.

VCacheFactory - Interface in com.atlassian.vcache

Represents the factory for creating caches.

VCacheUtils - Class in com.atlassian.vcache

Provides a helper utilities.

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

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