org.ehcache.expiry

Class Expirations

java.lang.Object

org.ehcache.expiry.Expirations

public final class Expirations
extends java.lang.Object

Utility class for getting predefined Expiry instances.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Expirations.ExpiryBuilder<K,V> Builder to create a simple Expiry.

Method Summary

Modifier and Type	Method and Description
static <K,V> Expirations.ExpiryBuilder<K,V>	builder() Fluent API for creating an Expiry instance where you can specify constant values for creation, access and update time.
static Expiry<java.lang.Object,java.lang.Object>	noExpiration() Get an Expiry instance for a non expiring (ie.
static Expiry<java.lang.Object,java.lang.Object>	timeToIdleExpiration(Duration timeToIdle) Get a time-to-idle (TTI) Expiry instance for the given Duration.
static Expiry<java.lang.Object,java.lang.Object>	timeToLiveExpiration(Duration timeToLive) Get a time-to-live (TTL) Expiry instance for the given Duration.

Methods inherited from class java.lang.Object

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

Method Detail

noExpiration

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

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

Returns:

the no expiry instance

timeToLiveExpiration

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

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

Parameters:

timeToLive - the TTL duration

Returns:

a TTL expiry

timeToIdleExpiration

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

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

Parameters:

timeToIdle - the TTI duration

Returns:

a TTI expiry

builder

public static <K,V> Expirations.ExpiryBuilder<K,V> builder()

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

Type Parameters:

K - the key type for the cache

V - the value type for the cache

Returns:

an Expiry builder