com.atlassian.vcache

Class ExternalCacheSettings

java.lang.Object

com.atlassian.vcache.ExternalCacheSettings

@PublicApi
public class ExternalCacheSettings
extends java.lang.Object

An immutable representation of settings for an ExternalCache.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
java.util.Optional<ChangeRate>	getDataChangeRateHint() Returns the hint for the expected change rate for data updates.
java.util.Optional<java.time.Duration>	getDefaultTtl() Returns the default time-to-live for entries when added.
java.util.Optional<java.lang.Integer>	getEntryCountHint() Returns the hint for the expected number of entries
java.util.Optional<ChangeRate>	getEntryGrowthRateHint() Returns the hint for the expected change rate for entry additions.
ExternalCacheSettings	override(ExternalCacheSettings overrides) Returns a new ExternalCacheSettings instance where the current settings are overridden with settings specified in overrides.

Methods inherited from class java.lang.Object

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

Method Detail

override

public ExternalCacheSettings override(ExternalCacheSettings overrides)

Returns a new ExternalCacheSettings instance where the current settings are overridden with settings specified in overrides.

Parameters:

overrides - contains the settings to override

Returns:

a new ExternalCacheSettings instance with the overrides settings applied.

getDefaultTtl

public java.util.Optional<java.time.Duration> getDefaultTtl()

Returns the default time-to-live for entries when added. The time-to-live is calculated on the time the entry was added or updated.

Returns:

the default time-to-live for entries when added.

getEntryCountHint

public java.util.Optional<java.lang.Integer> getEntryCountHint()

Returns the hint for the expected number of entries

Returns:

the hint for the expected number of entries

getDataChangeRateHint

public java.util.Optional<ChangeRate> getDataChangeRateHint()

Returns the hint for the expected change rate for data updates.

Returns:

the hint for the expected change rate for data updates.

getEntryGrowthRateHint

public java.util.Optional<ChangeRate> getEntryGrowthRateHint()

Returns the hint for the expected change rate for entry additions.

Returns:

the hint for the expected change rate for entry additions.