org.jsr107.ri

Class RICachedValue

java.lang.Object

org.jsr107.ri.RICachedValue

public class RICachedValue
extends Object

Represents the internal Cache Entry Value with in an RICache.

The actual value passed to the Cache is represented in an internal format, generated by passing the value through an RIInternalConverter.

RICachedValues additionally store and provide meta information about Cache Entry Values, including information for dealing with expiry.

Author:

Brian Oliver

See Also:

RIInternalConverter

Constructor Summary

Constructors

Constructor and Description
RICachedValue(Object internalValue, long creationTime, long expiryTime) Constructs an RICachedValue with the creation, access and modification times being the current time.

Method Summary

Modifier and Type	Method and Description
Object	get() Gets the internal value (without updating the access time).
long	getAccessCount() Gets the number of times the internal value has been accessed.
long	getAccessTime() Gets the time (since the Epoc) in milliseconds since the internal value was last accessed.
long	getCreationTime() Gets the time (since the Epoc) in milliseconds since the internal value was created.
long	getExpiryTime() Gets the time (since the Epoc) in milliseconds when the Cache Entry associated with this value should be considered expired.
Object	getInternalValue(long accessTime) Gets the internal value with the side-effect of updating the access time to that which is specified and incrementing the access count.
long	getModificationCount() Gets the number of times the internal value has been modified (set)
long	getModificationTime() Gets the time (since the Epoc) in milliseconds since the internal value was last modified.
boolean	isExpiredAt(long now) Determines if the Cache Entry associated with this value would be expired at the specified time
void	set(Object internalValue) Sets the internal value (without updating the modification time)
void	setExpiryTime(long expiryTime) Sets the time (since the Epoc) in milliseconds when the Cache Entry associated with this value should be considered expired.
void	setInternalValue(Object internalValue, long modificationTime) Sets the internal value with the additional side-effect of updating the modification time to that which is specified and incrementing the modification count.

Methods inherited from class java.lang.Object

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

Constructor Detail

RICachedValue

public RICachedValue(Object internalValue,
                     long creationTime,
                     long expiryTime)

Constructs an RICachedValue with the creation, access and modification times being the current time.

Parameters:

internalValue - the internal representation of the value

creationTime - the time when the cache entry was created

expiryTime - the time when the cache entry should expire

Method Detail

getCreationTime

public long getCreationTime()

Gets the time (since the Epoc) in milliseconds since the internal value was created.

Returns:

time in milliseconds (since the Epoc)

getAccessTime

public long getAccessTime()

Gets the time (since the Epoc) in milliseconds since the internal value was last accessed.

Returns:

time in milliseconds (since the Epoc)

getAccessCount

public long getAccessCount()

Gets the number of times the internal value has been accessed.

Returns:

the access count

getModificationTime

public long getModificationTime()

Gets the time (since the Epoc) in milliseconds since the internal value was last modified.

Returns:

time in milliseconds (since the Epoc)

getModificationCount

public long getModificationCount()

Gets the number of times the internal value has been modified (set)

Returns:

the modification count

getExpiryTime

public long getExpiryTime()

Gets the time (since the Epoc) in milliseconds when the Cache Entry associated with this value should be considered expired.

Returns:

time in milliseconds (since the Epoc)

setExpiryTime

public void setExpiryTime(long expiryTime)

Sets the time (since the Epoc) in milliseconds when the Cache Entry associated with this value should be considered expired.

Parameters:

expiryTime - time in milliseconds (since the Epoc)

isExpiredAt

public boolean isExpiredAt(long now)

Determines if the Cache Entry associated with this value would be expired at the specified time

Parameters:

now - time in milliseconds (since the Epoc)

Returns:

true if the value would be expired at the specified time

get

public Object get()

Gets the internal value (without updating the access time).

Returns:

the internal value

set

public void set(Object internalValue)

Sets the internal value (without updating the modification time)

Parameters:

internalValue - the new internal value

getInternalValue

public Object getInternalValue(long accessTime)

Gets the internal value with the side-effect of updating the access time to that which is specified and incrementing the access count.

Parameters:

accessTime - the time when the internal value was accessed

Returns:

the internal value

setInternalValue

public void setInternalValue(Object internalValue,
                             long modificationTime)

Sets the internal value with the additional side-effect of updating the modification time to that which is specified and incrementing the modification count.

Parameters:

internalValue - the new internal value

modificationTime - the time when the value was modified