GuavaJvmCache (Atlassian VCache 1.8.3-m1 API)

java.lang.Object
- com.atlassian.vcache.internal.core.service.GuavaJvmCache<K,V>

Type Parameters:

K - the key type

V - the value type

All Implemented Interfaces:

JvmCache<K,V>, LocalCacheOperations<K,V>, VCache
```
public class GuavaJvmCache<K,V>
extends Object
implements JvmCache<K,V>
```
Implementation of the JvmCache that uses Guava.

Since:

1.0

Constructor Summary

Constructors
Constructor and Description

GuavaJvmCache(String name, JvmCacheSettings settings)
Creates an instance.

Constructors
Constructor and Description
`GuavaJvmCache(String name, JvmCacheSettings settings)` Creates an instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Optional<V>`	`get(K key)` Returns a value that is associated with a specified key.
`V`	`get(K key, Supplier<? extends V> supplier)` Returns a value that may be associated with a specified key.
`Map<K,V>`	`getBulk(Function<Set<K>,Map<K,V>> factory, Iterable<K> keys)` Returns the values that are associated with the specified keys.
`Map<K,V>`	`getBulk(Function<Set<K>,Map<K,V>> factory, K... keys)` Returns the values that are associated with the specified keys.
`Set<K>`	`getKeys()` Gets the keys of all objects currently stored in the cache.
`String`	`getName()` The name of the cache, uniquely identifies this cache.
`void`	`put(K key, V value)` Unconditionally puts the value under the specified key.
`Optional<V>`	`putIfAbsent(K key, V value)` Conditionally puts the value under the specified key, if no entry currently exists.
`void`	`remove(K key)` Removes the entries for the supplied key.
`void`	`removeAll()` Removes all the entries in the cache.
`boolean`	`removeIf(K key, V value)` 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)`
`boolean`	`replaceIf(K key, V currentValue, V newValue)` 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)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GuavaJvmCache
```
public GuavaJvmCache(String name,
                     JvmCacheSettings settings)
```
    Creates an instance. NOTE: all the supplied settings must be set.
    
    Parameters:
    
    name - the name of the cache
    
    settings - the settings for the cache.
- Method Detail
  - getKeys
```
public Set<K> getKeys()
```
    Description copied from interface: JvmCache
    
    Gets the keys of all objects currently stored in the cache. This will return the keys in a new mutable set.
    
    Specified by:
    
    getKeys in interface JvmCache<K,V>
    
    Returns:
    
    a set of Objects keys
  - get
```
public Optional<V> get(K key)
```
    Description copied from interface: LocalCacheOperations
    
    Returns a value that is associated with a specified key.
    
    Specified by:
    
    get in interface LocalCacheOperations<K,V>
    
    Parameters:
    
    key - the key to check.
    
    Returns:
    
    an Optional which may contain the value associated with the key.
  - get
```
public V get(K key,
             Supplier<? extends V> supplier)
```
    Description copied from interface: LocalCacheOperations
    Returns a value that may be associated with a specified key.
    Notes:
    - If no entry for the specified key exists, then the specified supplier is called to create an entry in the cache, before it is returned.
    - The supplier implementation needs to be multi-thread safe as it may be called concurrently if multiple threads call this method.
    Specified by:
    
    get in interface LocalCacheOperations<K,V>
    
    Parameters:
    
    key - the key uniquely identifying the value to be retrieved
    
    supplier - used to generate the value, if one does not exist already for the key. The supplier may not return null.
    
    Returns:
    
    the value associated with the key.
  - getBulk
```
@SafeVarargs
public final Map<K,V> getBulk(Function<Set<K>,Map<K,V>> factory,
                                           K... keys)
```
    Description copied from interface: LocalCacheOperations
    
    Returns the values that are associated with the specified keys. It is equivalent to calling LocalCacheOperations.getBulk(Function, Iterable) passing factory and Arrays.asList(keys) as the parameters.
    
    Specified by:
    
    getBulk in interface LocalCacheOperations<K,V>
    
    Parameters:
    
    factory - used to generate the values for the keys that do not have entries. The factory must return a map containing only a non-null value for each supplied key. Extra keys are not allowed.
    
    keys - the keys to retrieve
    
    Returns:
    
    A Map that is keyed on the keys specified. Each entry in the Map will have the value associated with the key.
    
    See Also:
    
    LocalCacheOperations.getBulk(Function, Iterable)
  - getBulk
```
public Map<K,V> getBulk(Function<Set<K>,Map<K,V>> factory,
                        Iterable<K> keys)
```
    Description copied from interface: LocalCacheOperations
    Returns the values that are associated with the specified keys.
    Notes:
    - WARNING: this method is not multi-thread safe in conjunction with any methods that make single key mutations, such as LocalCacheOperations.remove(Object) or LocalCacheOperations.removeIf(Object, Object). Caller beware.
    - If there are any keys for which no entry exists, then the given factory is called exactly once with the argument being a Set containing exactly the keys for which no entry existed. The return value of the factory is used to populate the missing entries in the cache, and then the map of all requested keys to values is returned.
    - The call to the factory is made on the thread which calls getBulk.
    - Despite the fact that the keys are an Iterable, no guarantees are made about the order in which the cache is populated, nor the order in which the Set passed to the factory is iterated, nor in which the returned Map is iterated.
    Specified by:
    
    getBulk in interface LocalCacheOperations<K,V>
    
    Parameters:
    
    factory - used to generate the values for the keys that do not have entries. The factory must return a map containing only a non-null value for each supplied key. Extra keys are not allowed.
    
    keys - the keys to retrieve
    
    Returns:
    
    A Map that is keyed on the keys specified. Each entry in the Map will have the value associated with the key.
  - put
```
public void put(K key,
                V value)
```
    Description copied from interface: LocalCacheOperations
    
    Unconditionally puts the value under the specified key.
    
    Specified by:
    
    put in interface LocalCacheOperations<K,V>
    
    Parameters:
    
    key - the key to put the data under
    
    value - the value to associate with the key.
  - putIfAbsent
```
public Optional<V> putIfAbsent(K key,
                               V value)
```
    Description copied from interface: LocalCacheOperations
    
    Conditionally puts the value under the specified key, if no entry currently exists. Returns the current value associated with the key, if one currently exists.
    
    Specified by:
    
    putIfAbsent in interface LocalCacheOperations<K,V>
    
    Parameters:
    
    key - the key to put the data under
    
    value - the value to associate with the key.
    
    Returns:
    
    Optional.EMPTY is no entry previously existed, otherwise the Optional contains the current value.
  - replaceIf
```
public boolean replaceIf(K key,
                         V currentValue,
                         V newValue)
```
    Description copied from interface: 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)
    Specified by:
    
    replaceIf in interface LocalCacheOperations<K,V>
    
    Parameters:
    
    key - the key to replace data under
    
    currentValue - the current value to match
    
    newValue - the replacement value
    
    Returns:
    
    whether the current value are replaced with the supplied newValue
  - remove
```
public void remove(K key)
```
    Description copied from interface: LocalCacheOperations
    
    Removes the entries for the supplied key.
    
    Specified by:
    
    remove in interface LocalCacheOperations<K,V>
    
    Parameters:
    
    key - the key of the entry to remove
  - removeAll
```
public void removeAll()
```
    Description copied from interface: LocalCacheOperations
    
    Removes all the entries in the cache.
    
    Specified by:
    
    removeAll in interface LocalCacheOperations<K,V>
  - removeIf
```
public boolean removeIf(K key,
                        V value)
```
    Description copied from interface: 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)
    Specified by:
    
    removeIf in interface LocalCacheOperations<K,V>
    
    Parameters:
    
    key - the key of the entry to remove conditionally
    
    value - the current value to match
    
    Returns:
    
    whether an entry was removed
  - getName
```
public String getName()
```
    Description copied from interface: VCache
    
    The name of the cache, uniquely identifies this cache.
    
    Specified by:
    
    getName in interface VCache
    
    Returns:
    
    the name of the cache

Class GuavaJvmCache<K,V>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GuavaJvmCache

Method Detail

getKeys

get

get

getBulk

getBulk

put

putIfAbsent

replaceIf

remove

removeAll

removeIf

getName