Package org.eclipse.hono.cache

Class BasicExpiringValue<T>

java.lang.Object

org.eclipse.hono.cache.BasicExpiringValue<T>

Type Parameters:

T - The value type.

All Implemented Interfaces:

ExpiringValue<T>

public class BasicExpiringValue<T>
extends Object
implements ExpiringValue<T>

A base class for implementing an expiring value.

Constructor Summary

Constructors

Constructor	Description
BasicExpiringValue(T value, Instant expirationTime)	Creates a new instance for a value and an expiration time.

Method Summary

Modifier and Type	Method	Description
T	getValue()	Gets the value.
boolean	isExpired()	Checks if the value has already expired.
boolean	isExpired(Instant now)	Checks if the value has already expired.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicExpiringValue

public BasicExpiringValue(T value,
                          Instant expirationTime)

Creates a new instance for a value and an expiration time.

Parameters:

value - The value.

expirationTime - The instant after which the value will be considered expired.

Method Detail

getValue

public final T getValue()

Description copied from interface: ExpiringValue

Gets the value.

Specified by:

getValue in interface ExpiringValue<T>

Returns:

The value.

isExpired

public boolean isExpired()

Description copied from interface: ExpiringValue

Checks if the value has already expired.

Specified by:

isExpired in interface ExpiringValue<T>

Returns:

true if the value has expired based on the current system time, false otherwise.

isExpired

public boolean isExpired(Instant now)

Description copied from interface: ExpiringValue

Checks if the value has already expired.

Specified by:

isExpired in interface ExpiringValue<T>

Parameters:

now - The reference point in time to check expiration against.

Returns:

true if the value has expired based on the given instant, false otherwise.