com.hannesdorfmann.httpkit.cache

Interface CacheEntry<T>

All Known Implementing Classes:

DefaultCacheEntry, WeakCacheEntry

public interface CacheEntry<T>

This object represents an entry of a cache. It also contains some additional info (meta info) about the entry, the most important one is the expiration of a CacheEntry. To detect if an entry has expired a CacheEntryExpirator is used.

Author:

Hannes Dorfmann

Method Summary

Methods

Modifier and Type	Method and Description
String	getETag() Get the E-Tag, if there is any
long	getExpirationTimestamp() Get the expirationValue
<K> K	getValue() Get the real value of this entry.
boolean	isExpired() true if this CacheEntry has Expired, otherwise false.
void	setEntryExpirator(CacheEntryExpirator expirator) Set the CacheEntryExpirator that is used in isExpired() to determine if an CacheEntry is expired or not
void	setExpirationTimestamp(long expirationTimestamp) Seht the expiration timestamp, when this entry will expires

Method Detail

getExpirationTimestamp

long getExpirationTimestamp()

Get the expirationValue

Returns:

setEntryExpirator

void setEntryExpirator(CacheEntryExpirator expirator)

Set the CacheEntryExpirator that is used in isExpired() to determine if an CacheEntry is expired or not

Parameters:

expirator -

isExpired

boolean isExpired()

true if this CacheEntry has Expired, otherwise false. This method calls CacheEntryExpirator#isExpired(Object) to determine if the entry has expired or not.

Returns:

setExpirationTimestamp

void setExpirationTimestamp(long expirationTimestamp)

Seht the expiration timestamp, when this entry will expires

Parameters:

expirationTimestamp -

getValue

<K> K getValue()

Get the real value of this entry.

Returns:

getETag

String getETag()

Get the E-Tag, if there is any

Returns:

The e-tag (if there is one) or null