software.amazon.awssdk.utils.cache

Class CachedSupplier.Builder<T>

java.lang.Object

software.amazon.awssdk.utils.cache.CachedSupplier.Builder<T>

Enclosing class:

CachedSupplier<T>

public static final class CachedSupplier.Builder<T>
extends Object

A Builder for CachedSupplier, created by CachedSupplier.builder(Supplier).

Method Summary

Modifier and Type	Method and Description
CachedSupplier<T>	build() Create a CachedSupplier using the current configuration of this builder.
CachedSupplier.Builder<T>	cachedValueName(String cachedValueName) Configures a name for the cached value.
CachedSupplier.Builder<T>	clock(Clock clock) Configure the clock used for this cached supplier.
CachedSupplier.Builder<T>	prefetchStrategy(CachedSupplier.PrefetchStrategy prefetchStrategy) Configure the way in which data in the cache should be pre-fetched when the data's RefreshResult.prefetchTime() arrives.
CachedSupplier.Builder<T>	staleValueBehavior(CachedSupplier.StaleValueBehavior staleValueBehavior) Configure the way the cache should behave when a stale value is retrieved or when retrieving a value fails while the cache is stale.

Methods inherited from class java.lang.Object

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

Method Detail

prefetchStrategy

public CachedSupplier.Builder<T> prefetchStrategy(CachedSupplier.PrefetchStrategy prefetchStrategy)

Configure the way in which data in the cache should be pre-fetched when the data's RefreshResult.prefetchTime() arrives. By default, this uses the OneCallerBlocks strategy, which will block a single CachedSupplier.get() caller to update the value.

staleValueBehavior

public CachedSupplier.Builder<T> staleValueBehavior(CachedSupplier.StaleValueBehavior staleValueBehavior)

Configure the way the cache should behave when a stale value is retrieved or when retrieving a value fails while the cache is stale. By default, this uses CachedSupplier.StaleValueBehavior.STRICT.

cachedValueName

public CachedSupplier.Builder<T> cachedValueName(String cachedValueName)

Configures a name for the cached value. This name will be included with logs emitted by this supplier, to aid in debugging. By default, this uses "unknown".

clock

public CachedSupplier.Builder<T> clock(Clock clock)

Configure the clock used for this cached supplier. Configurable for testing.

build

public CachedSupplier<T> build()

Create a CachedSupplier using the current configuration of this builder.