Package org.apache.fulcrum.cache
Class CachedObject<T>
java.lang.Object
org.apache.fulcrum.cache.CachedObject<T>
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
RefreshableCachedObject
Wrapper for an object you want to store in a cache for a period of time.
- Version:
- $Id$
- Author:
- Dave Bryson, Henning P. Schmiedehausen, Eric Pugh
- See Also:
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionCachedObject
(T object) Constructor; sets the object to expire in the default time (30 minutes).CachedObject
(T object, long expires) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionReturns the cached object.long
Returns the creation time for the object.long
Returns the expiration time for the object.boolean
isStale()
Is the object stale?void
setExpires
(long expires) Set the expiration interval for the object.void
setStale
(boolean stale) Set the stale status for the object.
-
Field Details
-
DEFAULT
public static final int DEFAULTCache the object with the Default TTL- See Also:
-
FOREVER
public static final int FOREVERDo not expire the object- See Also:
-
created
protected long createdWhen the object is created.
-
-
Constructor Details
-
CachedObject
Constructor; sets the object to expire in the default time (30 minutes).- Parameters:
object
- The object you want to cache.
-
CachedObject
Constructor.- Parameters:
object
- The object to cache.expires
- How long before the object expires, in ms, e.g. 1000 = 1 second.
-
-
Method Details
-
getContents
Returns the cached object.- Returns:
- The cached object.
-
getCreated
public long getCreated()Returns the creation time for the object.- Returns:
- When the object was created.
-
getExpires
public long getExpires()Returns the expiration time for the object.- Returns:
- When the object expires.
-
setExpires
public void setExpires(long expires) Set the expiration interval for the object.- Parameters:
expires
- Expiration interval in millis ( 1 second = 1000 millis)
-
setStale
public void setStale(boolean stale) Set the stale status for the object.- Parameters:
stale
- Whether the object is stale or not.
-
isStale
public boolean isStale()Is the object stale?- Returns:
- True if the object is stale.
-