net.jodah.expiringmap

Class ExpiringMap.Builder

java.lang.Object

net.jodah.expiringmap.ExpiringMap.Builder

Enclosing class:

ExpiringMap<K,V>

public static final class ExpiringMap.Builder
extends Object

Builds ExpiringMap instances. Defaults to ExpirationPolicy.CREATED and expiration of 60 TimeUnit.SECONDS.

Method Summary

Methods

Modifier and Type	Method and Description
<K,V> ExpiringMap<K,V>	build() Builds and returns an expiring map.
ExpiringMap.Builder	expiration(long duration, TimeUnit timeUnit) Sets the default map entry expiration.
ExpiringMap.Builder	expirationListener(ExpiringMap.ExpirationListener<?,?>... listeners) Sets expiration listeners which will receive notifications upon each map entry's expiration.
ExpiringMap.Builder	expirationPolicy(ExpiringMap.ExpirationPolicy expirationPolicy) Sets the map entry expiration policy.
ExpiringMap.Builder	variableExpiration() Allows for map entries to have individual expirations and for expirations to be changed.

Methods inherited from class java.lang.Object

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

Method Detail

build

public <K,V> ExpiringMap<K,V> build()

Builds and returns an expiring map.

Type Parameters:

K - Key type

V - Value type

expiration

public ExpiringMap.Builder expiration(long duration,
                             TimeUnit timeUnit)

Sets the default map entry expiration.

Parameters:

duration - the length of time after an entry is created that it should be removed

timeUnit - unit the unit that duration is expressed in

expirationListener

public ExpiringMap.Builder expirationListener(ExpiringMap.ExpirationListener<?,?>... listeners)

Sets expiration listeners which will receive notifications upon each map entry's expiration.

Parameters:

listeners - to set

Returns:

expirationPolicy

public ExpiringMap.Builder expirationPolicy(ExpiringMap.ExpirationPolicy expirationPolicy)

Sets the map entry expiration policy.

Parameters:

expirationPolicy -

variableExpiration

public ExpiringMap.Builder variableExpiration()

Allows for map entries to have individual expirations and for expirations to be changed.