com.codelanx.commons.util.cache

Class ExpiringMap.Builder<K,V>

java.lang.Object

com.codelanx.commons.util.cache.ExpiringMap.Builder<K,V>

Type Parameters:

K - The key type

V - The value type

Enclosing class:

ExpiringMap<K,V>

public static final class ExpiringMap.Builder<K,V>
extends Object

Builder object for an ExpiringMap. Defaults to using ExpiringMap.ExpirationPolicy.ACCESSED and an expiration time of 5 TimeUnit.MINUTES

Since:

0.1.0

Version:

0.1.0

Method Summary

Modifier and Type	Method and Description
<K1 extends K,V1 extends V> ExpiringMap<K1,V1>	build() Builds and returns an expiring map.
<K1 extends K,V1 extends V> ExpiringMap.Builder<K1,V1>	entryLoader(Function<? super K1,? super V1> loader) Sets the Function that is called when an entry is expired and should be re-initialized
ExpiringMap.Builder<K,V>	expiration(long duration, TimeUnit timeUnit) Sets the default map entry expiration.
ExpiringMap.Builder<K,V>	expirationPolicy(ExpiringMap.ExpirationPolicy expirationPolicy) Sets the map entry expiration policy.
<K1 extends K,V1 extends V> ExpiringMap.Builder<K1,V1>	onExpiry(BiConsumer<? super K1,? super V1> expired) Sets the BiConsumer to apply to expired entries
ExpiringMap.Builder<K,V>	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 <K1 extends K,V1 extends V> ExpiringMap<K1,V1> build()

Builds and returns an expiring map.

Type Parameters:

K1 - The key type

V1 - The value type

Returns:

a new ExpiringMap object

Since:

0.1.0

expiration

public ExpiringMap.Builder<K,V> 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 - the unit that duration is expressed in

Returns:

This builder object (chained)

Since:

0.1.0

entryLoader

public <K1 extends K,V1 extends V> ExpiringMap.Builder<K1,V1> entryLoader(Function<? super K1,? super V1> loader)

Sets the Function that is called when an entry is expired and should be re-initialized

Type Parameters:

K1 - The type of the keys to deal with

V1 - The type of the values to deal with

Parameters:

loader - to set

Returns:

This builder object (chained)

Since:

0.1.0

onExpiry

public <K1 extends K,V1 extends V> ExpiringMap.Builder<K1,V1> onExpiry(BiConsumer<? super K1,? super V1> expired)

Sets the BiConsumer to apply to expired entries

Type Parameters:

K1 - The type of the keys to deal with

V1 - The type of the values to deal with

Parameters:

expired - A BiConsumer that is applied to entries upon expiration

Returns:

This builder object (chained)

Since:

0.1.0

expirationPolicy

public ExpiringMap.Builder<K,V> expirationPolicy(ExpiringMap.ExpirationPolicy expirationPolicy)

Sets the map entry expiration policy.

Parameters:

expirationPolicy - The ExpiringMap.ExpirationPolicy to set

Returns:

This builder object (chained)

Since:

0.1.0

variableExpiration

public ExpiringMap.Builder<K,V> variableExpiration()

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

Returns:

This builder object (chained)

Since:

0.1.0