com.atlassian.vcache

Interface DirectExternalCache<V>

Type Parameters:

V - the value type

All Superinterfaces:

ExternalCache<V>, ExternalWriteOperationsUnbuffered<V>, VCache

All Known Implementing Classes:

GuavaDirectExternalCache

@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
CompletionStage<Map<String,Optional<IdentifiedValue<V>>>>	getBulkIdentified(Iterable<String> keys) Returns the IdentifiedValue's that are associated with the specified keys.
default CompletionStage<Map<String,Optional<IdentifiedValue<V>>>>	getBulkIdentified(String... keys) Returns the IdentifiedValue's that are associated with the specified keys.
CompletionStage<Optional<IdentifiedValue<V>>>	getIdentified(String key) Returns an identified value that is associated with a specified key.
CompletionStage<IdentifiedValue<V>>	getIdentified(String key, Supplier<V> supplier) Returns an identified value that is associated with a specified key.
CompletionStage<Boolean>	removeIf(String key, CasIdentifier casId) Removes the specified entry, iff the specified CAS identifier matches.
CompletionStage<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

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

getIdentified

CompletionStage<IdentifiedValue<V>> getIdentified(String key,
                                                  Supplier<V> supplier)

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.

supplier - used to generate the value, if one does not exist already for the key. The supplier may not return null.

Returns:

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

getBulkIdentified

default CompletionStage<Map<String,Optional<IdentifiedValue<V>>>> getBulkIdentified(String... keys)

Returns the IdentifiedValue's that are associated with the specified keys. It is equivalent to calling getBulkIdentified(Iterable) passing Arrays.asList(keys) as the parameter.

Parameters:

keys - the keys to check.

Returns:

A Map that is keyed on the keys specified. Each entry in the Map will have Optional which may contain the IdentifiedValue associated with the key.

getBulkIdentified

CompletionStage<Map<String,Optional<IdentifiedValue<V>>>> getBulkIdentified(Iterable<String> keys)

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

Parameters:

keys - the keys to check.

Returns:

A Map that is keyed on the keys specified. Each entry in the Map will have Optional which may contain the IdentifiedValue associated with the key.

removeIf

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

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