@FieldsAreNonnullByDefault @ParametersAreNonnullByDefault @ReturnValuesAreNonnullByDefault

Package com.atlassian.vcache

Contains the core types for Atlassian VCache API.

See: Description

Interface Summary

Interface	Description
CasIdentifier	Represents an identifier for use in compare-and-swap operations.
DirectExternalCache<V>	Represents an ExternalCache where all operations are performed directly on the external cache system.
ExternalCache<V>	Represents an external cache, where the data is ultimately stored in external cache systems like Memcached or Redis.
ExternalWriteOperationsBuffered<V>	Represents the buffered write operations on an ExternalCache.
ExternalWriteOperationsUnbuffered<V>	Represents the unbuffered write operations on an ExternalCache.
IdentifiedValue<T>	Represents a value that has an associated CasIdentifier that can be used for "compare-and-swap" operations.
JvmCache<K,V>	Interface that defines the JVM cache operations.
LocalCacheOperations<K,V>	Represents the common operations that can be performed on a JVM local cache.
Marshaller<T>	Deprecated since 1.5.0.
RequestCache<K,V>	Represents a request scope cache, which is intended to hold data for the life of a request.
StableReadExternalCache<V>	Represents an ExternalCache where the read operations are buffered.
TransactionalExternalCache<V>	Represents an ExternalCache where both the read and write operations are buffered until the end of a transaction.
VCache	Represents the characteristics common to all types of caches.
VCacheFactory	Represents the factory for creating caches.

Class Summary

Class	Description
ExternalCacheSettings	An immutable representation of settings for an ExternalCache.
ExternalCacheSettingsBuilder	Builder for creating ExternalCacheSettings instances.
JvmCacheSettings	An immutable representation of settings for an JvmCache.
JvmCacheSettingsBuilder	Builder for creating JvmCacheSettings instances.
RequestCacheSettings	Settings for configuring a RequestCache.
RequestCacheSettingsBuilder	Builder for creating RequestCacheSettings instances.
VCacheUtils	Provides a helper utilities.

Enum Summary

Enum	Description
ChangeRate	Provides a scale for the rate of change of a measure.
ExternalCacheException.Reason	The reasons for failure.
PutPolicy	Represents the different policies for a put operation on a cache.

Exception Summary

Exception	Description
ExternalCacheException	Represents a failure occurred with an ExternalCache.
MarshallerException	Deprecated since 1.5.0.
VCacheException	Represents a failure occurred when using the VCache API.

Package com.atlassian.vcache Description

Contains the core types for Atlassian VCache API. This API is independent of the Atlassian Cache API.

Three types of caches are supported:

• JvmCache which is intended to hold data within the JVM. It similar to the local version of the Atlassian Cache v2 {code Cache}. Use of these caches is discouraged, and caching implementations may decide to restrict the creation of this type of cache (e.g. through maintaining white-lists).
• RequestCache which is intended to hold data for the life of a request, where a request is a unit-of-work as managed by the host application. Examples may be be a web request, a scheduled job or a background task).
• ExternalCache which is intended to hold partitioned data externally to the JVM. How the data is partitioned is dependant on the host application, so refer to the relevant documentation. As an example, a host application that supports multi-tenancy may partition data by tenant.

Since:

1.0