software.amazon.jdbc.util.storage

Class CacheItem<V>

java.lang.Object

software.amazon.jdbc.util.storage.CacheItem<V>

public class CacheItem<V>
extends java.lang.Object

A container class that holds a cache value together with the time at which the value should be considered expired.

Field Summary

Fields

Modifier and Type	Field and Description
protected long	expirationTimeNanos
protected V	item
protected @Nullable ShouldDisposeFunc<V>	shouldDisposeFunc

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CacheItem(V item, long expirationTimeNanos) Constructs a CacheItem.
protected	CacheItem(V item, long expirationTimeNanos, @Nullable ShouldDisposeFunc<V> shouldDisposeFunc) Constructs a CacheItem.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
protected void	extendExpiration(long timeToLiveNanos) Renews a cache item's expiration time.
int	hashCode()
protected boolean	isExpired() Indicates whether this item is expired.
protected boolean	shouldCleanup() Determines if a cache item should be cleaned up.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

item

protected final V item

expirationTimeNanos

protected long expirationTimeNanos

shouldDisposeFunc

protected final @Nullable ShouldDisposeFunc<V> shouldDisposeFunc

Constructor Detail

CacheItem

protected CacheItem(V item,
                    long expirationTimeNanos)

Constructs a CacheItem.

Parameters:

item - the item value.

expirationTimeNanos - the time at which the CacheItem should be considered expired.

CacheItem

protected CacheItem(V item,
                    long expirationTimeNanos,
                    @Nullable ShouldDisposeFunc<V> shouldDisposeFunc)

Constructs a CacheItem.

Parameters:

item - the item value.

expirationTimeNanos - the time at which the CacheItem should be considered expired.

shouldDisposeFunc - a function defining whether an expired item should be disposed. If null, items will always be disposed when expired.

Method Detail

isExpired

protected boolean isExpired()

Indicates whether this item is expired.

Returns:

true if this item is expired, otherwise returns false.

extendExpiration

protected void extendExpiration(long timeToLiveNanos)

Renews a cache item's expiration time.

Parameters:

timeToLiveNanos - the duration that the item should sit in the cache before being considered expired, in nanoseconds.

shouldCleanup

protected boolean shouldCleanup()

Determines if a cache item should be cleaned up. An item should be cleaned up if it has past its expiration time and the ShouldDisposeFunc (if defined) indicates that it should be cleaned up.

Returns:

true if the cache item should be cleaned up. Otherwise, returns false.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object