com.atlassian.vcache

Class JvmCacheSettingsBuilder

java.lang.Object

com.atlassian.vcache.JvmCacheSettingsBuilder

@PublicApi
public class JvmCacheSettingsBuilder
extends Object

Builder for creating JvmCacheSettings instances.

Since:

1.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
JvmCacheSettings	build() Returns a new JvmCacheSettings instance configured using the supplied settings.
JvmCacheSettingsBuilder	defaultTtl(Duration ttl) Specifies the default time-to-live for entries to be held in the cache.
JvmCacheSettingsBuilder	maxEntries(int max) Specifies the maximum number of entries to be held in the cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

JvmCacheSettingsBuilder

public JvmCacheSettingsBuilder()

Creates an instance with no settings initialised.

JvmCacheSettingsBuilder

public JvmCacheSettingsBuilder(JvmCacheSettings settings)

Constructs an instance initialised with the supplied settings.

Parameters:

settings - the settings to configure the instance with.

Method Detail

build

@Nonnull
public JvmCacheSettings build()

Returns a new JvmCacheSettings instance configured using the supplied settings.

Returns:

a new JvmCacheSettings instance configured using the supplied settings.

maxEntries

@Nonnull
public JvmCacheSettingsBuilder maxEntries(int max)

Specifies the maximum number of entries to be held in the cache. Must not be a negative number. When 0 is specified, the entries will be evicted immediately after being loaded into the cache.

Parameters:

max - the number of entries to be held in the cache

Returns:

the builder

Throws:

IllegalArgumentException - thrown if max is negative

defaultTtl

@Nonnull
public JvmCacheSettingsBuilder 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