org.omnifaces.component.output.cache

Class CacheEntry

java.lang.Object

org.omnifaces.component.output.cache.CacheEntry

public class CacheEntry
extends Object

Meta data for a value that's stored in a cache. Can be used for cache implementations that don't support this concept natively.

Since:

1.1

Author:

Arjan Tijms

Constructor Summary

Constructors

Constructor and Description
CacheEntry(String value, Date validTill)

Method Summary

Methods

Modifier and Type	Method and Description
Date	getValidTill() Returns the date that's the last moment in time the value obtained via getValue() is valid.
String	getValue() Returns the value for which this object is keeping meta data
boolean	isValid() Returns whether this entry holds a valid value.

Methods inherited from class java.lang.Object

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

Constructor Detail

CacheEntry

public CacheEntry(String value,
          Date validTill)

Method Detail

getValue

public String getValue()

Returns the value for which this object is keeping meta data

Returns:

The value for which meta data is kept

getValidTill

public Date getValidTill()

Returns the date that's the last moment in time the value obtained via getValue() is valid. After that moment, the value should not be used.

Returns:

date indicating last moment value hold by this object is valid.

isValid

public boolean isValid()

Returns whether this entry holds a valid value. If false is returned, the value should not be used and the cache implementation should try to remove this entry and its associated value from the cache.

Returns:

true if this entry is still valid, false otherwise.