net.jodah.expiringmap

Class ExpiringValue<V>

java.lang.Object

net.jodah.expiringmap.ExpiringValue<V>

Type Parameters:

V - the type of value being stored

public final class ExpiringValue<V>
extends Object

A value which should be stored in an ExpiringMap with optional control over its expiration.

Constructor Summary

Constructors

Constructor and Description
ExpiringValue(V value) Creates an ExpiringValue to be stored in an ExpiringMap.
ExpiringValue(V value, ExpirationPolicy expirationPolicy) Creates an ExpiringValue to be stored in an ExpiringMap.
ExpiringValue(V value, ExpirationPolicy expirationPolicy, long duration, TimeUnit timeUnit) Creates an ExpiringValue to be stored in an ExpiringMap.
ExpiringValue(V value, long duration, TimeUnit timeUnit) Creates an ExpiringValue to be stored in an ExpiringMap.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
long	getDuration()
ExpirationPolicy	getExpirationPolicy()
TimeUnit	getTimeUnit()
V	getValue()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ExpiringValue

public ExpiringValue(V value)

Creates an ExpiringValue to be stored in an ExpiringMap. The map's default values for expiration policy and ExpiringMap.getExpiration() expiration} will be used.

Parameters:

value - the value to store

See Also:

ExpiringMap.put(Object, Object)

ExpiringValue

public ExpiringValue(V value,
                     ExpirationPolicy expirationPolicy)

Creates an ExpiringValue to be stored in an ExpiringMap. The map's default ExpiringMap.getExpiration() expiration} will be used.

Parameters:

value - the value to store

expirationPolicy - the expiration policy for the value

See Also:

ExpiringMap.put(Object, Object, ExpirationPolicy)

ExpiringValue

public ExpiringValue(V value,
                     long duration,
                     TimeUnit timeUnit)

Creates an ExpiringValue to be stored in an ExpiringMap. The map's default expiration policy will be used.

Parameters:

value - the value to store

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

timeUnit - the unit that duration is expressed in

Throws:

NullPointerException - on null timeUnit

See Also:

ExpiringMap.put(Object, Object, long, TimeUnit)

ExpiringValue

public ExpiringValue(V value,
                     ExpirationPolicy expirationPolicy,
                     long duration,
                     TimeUnit timeUnit)

Creates an ExpiringValue to be stored in an ExpiringMap.

Parameters:

value - the value to store

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

timeUnit - the unit that duration is expressed in

expirationPolicy - the expiration policy for the value

Throws:

NullPointerException - on null timeUnit

See Also:

ExpiringMap.put(Object, Object, ExpirationPolicy, long, TimeUnit)

Method Detail

getValue

public V getValue()

getExpirationPolicy

public ExpirationPolicy getExpirationPolicy()

getDuration

public long getDuration()

getTimeUnit

public TimeUnit getTimeUnit()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object