com.atlassian.vcache

Class ExternalCacheSettingsBuilder

java.lang.Object

com.atlassian.vcache.ExternalCacheSettingsBuilder

@PublicApi
public class ExternalCacheSettingsBuilder
extends Object

Builder for creating ExternalCacheSettings instances.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
ExternalCacheSettingsBuilder() Creates an instance with no settings initialised.
ExternalCacheSettingsBuilder(ExternalCacheSettings settings) Constructs an instance initialised with the supplied settings.

Method Summary

Modifier and Type	Method and Description
ExternalCacheSettings	build() Returns a new ExternalCacheSettings instance configured using the supplied settings.
ExternalCacheSettingsBuilder	dataChangeRateHint(ChangeRate hint) Provides a hint on the expected change rate for data updates.
ExternalCacheSettingsBuilder	defaultTtl(Duration ttl) Specifies the default time-to-live for entries to be held in the cache.
ExternalCacheSettingsBuilder	entryCountHint(int hint) Provides a hint on the expected number of entries to be held in the cache.
ExternalCacheSettingsBuilder	entryGrowthRateHint(ChangeRate hint) Provides a hint on the expected change rate for entry additions.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalCacheSettingsBuilder

public ExternalCacheSettingsBuilder()

Creates an instance with no settings initialised.

ExternalCacheSettingsBuilder

public ExternalCacheSettingsBuilder(ExternalCacheSettings settings)

Constructs an instance initialised with the supplied settings.

Parameters:

settings - the settings to configure the instance with.

Method Detail

build

@Nonnull
public ExternalCacheSettings build()

Returns a new ExternalCacheSettings instance configured using the supplied settings.

Returns:

a new ExternalCacheSettings instance configured using the supplied settings.

defaultTtl

@Nonnull
public ExternalCacheSettingsBuilder defaultTtl(Duration ttl)

Specifies the default time-to-live for entries to be held in the cache. Must be a positive number.

Parameters:

ttl - the default time-to-live for entries to be held in the cache

Returns:

the builder

Throws:

IllegalArgumentException - thrown if ttl is not positive

entryCountHint

@Nonnull
public ExternalCacheSettingsBuilder entryCountHint(int hint)

Provides a hint on the expected number of entries to be held in the cache. Must not be a negative number. The implementation is free to decide how to interpret 0. For example, it may decide to still cache values externally, or it may decide to not store entries in the cache.

Parameters:

hint - the expected number of entries to be held in the cache

Returns:

the builder

Throws:

IllegalArgumentException - thrown if hint is negative

dataChangeRateHint

@Nonnull
public ExternalCacheSettingsBuilder dataChangeRateHint(ChangeRate hint)

Provides a hint on the expected change rate for data updates.

Parameters:

hint - the expected change rate for data updates.

Returns:

the builder

entryGrowthRateHint

@Nonnull
public ExternalCacheSettingsBuilder entryGrowthRateHint(ChangeRate hint)

Provides a hint on the expected change rate for entry additions.

Parameters:

hint - the expected change rate for entry additions.

Returns:

the builder