org.ehcache.config.builders

Class ExpiryPolicyBuilder

java.lang.Object

org.ehcache.config.builders.ExpiryPolicyBuilder

All Implemented Interfaces:

Builder<ExpiryPolicy<java.lang.Object,java.lang.Object>>

public final class ExpiryPolicyBuilder
extends java.lang.Object
implements Builder<ExpiryPolicy<java.lang.Object,java.lang.Object>>

Builder and utilities for getting predefined ExpiryPolicy instances.

Method Summary

Modifier and Type	Method and Description
ExpiryPolicyBuilder	access(java.time.Duration access) Set TTL since last access
ExpiryPolicy<java.lang.Object,java.lang.Object>	build() Builds an instance.
ExpiryPolicyBuilder	create(java.time.Duration create) Set TTL since creation
static ExpiryPolicyBuilder	expiry() Fluent API for creating an ExpiryPolicy instance where you can specify constant values for creation, access and update time.
static ExpiryPolicy<java.lang.Object,java.lang.Object>	noExpiration() Get an ExpiryPolicy instance for a non expiring (ie.
static ExpiryPolicy<java.lang.Object,java.lang.Object>	timeToIdleExpiration(java.time.Duration timeToIdle) Get a time-to-idle (TTI) ExpiryPolicy instance for the given Duration.
static ExpiryPolicy<java.lang.Object,java.lang.Object>	timeToLiveExpiration(java.time.Duration timeToLive) Get a time-to-live (TTL) ExpiryPolicy instance for the given Duration.
ExpiryPolicyBuilder	update(java.time.Duration update) Set TTL since last update

Methods inherited from class java.lang.Object

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

Method Detail

noExpiration

public static ExpiryPolicy<java.lang.Object,java.lang.Object> noExpiration()

Get an ExpiryPolicy instance for a non expiring (ie. "eternal") cache.

Returns:

the no expiry instance

timeToLiveExpiration

public static ExpiryPolicy<java.lang.Object,java.lang.Object> timeToLiveExpiration(java.time.Duration timeToLive)

Get a time-to-live (TTL) ExpiryPolicy instance for the given Duration.

Parameters:

timeToLive - the TTL duration

Returns:

a TTL expiry

timeToIdleExpiration

public static ExpiryPolicy<java.lang.Object,java.lang.Object> timeToIdleExpiration(java.time.Duration timeToIdle)

Get a time-to-idle (TTI) ExpiryPolicy instance for the given Duration.

Parameters:

timeToIdle - the TTI duration

Returns:

a TTI expiry

expiry

public static ExpiryPolicyBuilder expiry()

Fluent API for creating an ExpiryPolicy instance where you can specify constant values for creation, access and update time. Unspecified values will be set to INFINITE for create and null for access and update, matching the noExpiration() no expiration} expiry.

Returns:

an ExpiryPolicy builder

create

public ExpiryPolicyBuilder create(java.time.Duration create)

Set TTL since creation

Parameters:

create - TTL since creation

Returns:

this builder

access

public ExpiryPolicyBuilder access(java.time.Duration access)

Set TTL since last access

Parameters:

access - TTL since last access

Returns:

this builder

update

public ExpiryPolicyBuilder update(java.time.Duration update)

Set TTL since last update

Parameters:

update - TTL since last update

Returns:

this builder

build

public ExpiryPolicy<java.lang.Object,java.lang.Object> build()

Description copied from interface: Builder

Builds an instance.

Specified by:

build in interface Builder<ExpiryPolicy<java.lang.Object,java.lang.Object>>

Returns:

an ExpiryPolicy