com.atlassian.vcache

Interface DirectExternalCache<V>

Type Parameters:

V - the value type

All Superinterfaces:

ExternalCache<V>, ExternalWriteOperationsUnbuffered<V>, VCache

@PublicApi
public interface DirectExternalCache<V>
extends ExternalCache<V>, ExternalWriteOperationsUnbuffered<V>

Represents an ExternalCache where all operations are performed directly on the external cache system. See the ExternalCache documentation for more information.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Map<String,Optional<IdentifiedValue<V>>>>	getBulkIdentified(Iterable<String> keys)
default CompletableFuture<Map<String,Optional<IdentifiedValue<V>>>>	getBulkIdentified(String... keys)
CompletableFuture<Optional<IdentifiedValue<V>>>	getIdentified(String key) Returns an identified value that is associated with a specified key.
CompletableFuture<Boolean>	removeIf(String key, CasIdentifier casId) Removes the specified entry, iff the specified CAS identifier matches.
CompletableFuture<Boolean>	replaceIf(String key, CasIdentifier casId, V newValue) Replaces the value for a specified entry, iff the specified CAS identifier matches.

Methods inherited from interface com.atlassian.vcache.ExternalCache

get, get, getBulk, getBulk, getBulk, getBulk

Methods inherited from interface com.atlassian.vcache.VCache

getName

Methods inherited from interface com.atlassian.vcache.ExternalWriteOperationsUnbuffered

put, remove, remove, removeAll

Method Detail

getIdentified

@Nonnull
CompletableFuture<Optional<IdentifiedValue<V>>> getIdentified(String key)

Returns an identified value that is associated with a specified key. The IdentifiedValue.identifier() may be used in subsequent CAS operations, such as removeIf(String, CasIdentifier) and replaceIf(String, CasIdentifier, Object).

Parameters:

key - the key to check.

Returns:

an Optional which may contain the identified value associated with the key.

getBulkIdentified

@Nonnull
default CompletableFuture<Map<String,Optional<IdentifiedValue<V>>>> getBulkIdentified(String... keys)

getBulkIdentified

@Nonnull
CompletableFuture<Map<String,Optional<IdentifiedValue<V>>>> getBulkIdentified(Iterable<String> keys)

removeIf

@Nonnull
CompletableFuture<Boolean> removeIf(String key,
                                             CasIdentifier casId)

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

Parameters:

key - the key of the entry to remove

casId - the CAS identifier to match

Returns:

whether the entry was removed

replaceIf

@Nonnull
CompletableFuture<Boolean> replaceIf(String key,
                                              CasIdentifier casId,
                                              V newValue)

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

Parameters:

key - the key of the entry to replace it's value

casId - the CAS identifier to match

newValue - the new value to replace with

Returns:

whether the value was replaced