org.dataloader.impl

Class NoOpValueCache<K,V>

java.lang.Object

org.dataloader.impl.NoOpValueCache<K,V>

Type Parameters:

K - the type of cache keys

V - the type of cache values

All Implemented Interfaces:

ValueCache<K,V>

public class NoOpValueCache<K,V>
extends java.lang.Object
implements ValueCache<K,V>

Implementation of ValueCache that does nothing.

We don't want to store values in memory twice, so when using the default store we just say we never have the key and complete the other methods by doing nothing.

Field Summary

Fields

Modifier and Type	Field and Description
static NoOpValueCache<?,?>	NOOP

Constructor Summary

Constructors

Constructor and Description
NoOpValueCache()

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.CompletableFuture<java.lang.Void>	clear() Clears all entries from the value cache.
java.util.concurrent.CompletableFuture<java.lang.Void>	delete(K key) Deletes the entry with the specified key from the value cache, if it exists.
java.util.concurrent.CompletableFuture<V>	get(K key) Gets the specified key from the value cache.
java.util.concurrent.CompletableFuture<V>	set(K key, V value) Stores the value with the specified key, or updates it if the key already exists.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.dataloader.ValueCache

defaultValueCache, getValues, setValues

Field Detail

NOOP

public static NoOpValueCache<?,?> NOOP

Constructor Detail

NoOpValueCache

public NoOpValueCache()

Method Detail

get

public java.util.concurrent.CompletableFuture<V> get(K key)

Gets the specified key from the value cache. If the key is not present, then the implementation MUST return an exceptionally completed future and not null because null is a valid cacheable value. An exceptionally completed future will cause DataLoader to load the key via batch loading instead.

Specified by:

get in interface ValueCache<K,V>

Parameters:

key - the key to retrieve

Returns:

a future containing the cached value (which maybe null) or exceptionally completed future if the key does not exist in the cache.

set

public java.util.concurrent.CompletableFuture<V> set(K key,
                                                     V value)

Stores the value with the specified key, or updates it if the key already exists.

Specified by:

set in interface ValueCache<K,V>

Parameters:

key - the key to store

value - the value to store

Returns:

a future containing the stored value for fluent composition

delete

public java.util.concurrent.CompletableFuture<java.lang.Void> delete(K key)

Deletes the entry with the specified key from the value cache, if it exists.

NOTE: Your implementation MUST not throw exceptions, rather it should return a CompletableFuture that has completed exceptionally. Failure to do this may cause the DataLoader code to not run properly.

Specified by:

delete in interface ValueCache<K,V>

Parameters:

key - the key to delete

Returns:

a void future for error handling and fluent composition

clear

public java.util.concurrent.CompletableFuture<java.lang.Void> clear()

Clears all entries from the value cache.

NOTE: Your implementation MUST not throw exceptions, rather it should return a CompletableFuture that has completed exceptionally. Failure to do this may cause the DataLoader code to not run properly.

Specified by:

clear in interface ValueCache<K,V>

Returns:

a void future for error handling and fluent composition