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 SummaryFields
- 
Constructor SummaryConstructorsConstructorDescriptionCachedObject(T object) Constructor; sets the object to expire in the default time (30 minutes).CachedObject(T object, long expires) Constructor.
- 
Method SummaryModifier and TypeMethodDescriptionReturns the cached object.longReturns the creation time for the object.longReturns the expiration time for the object.booleanisStale()Is the object stale?voidsetExpires(long expires) Set the expiration interval for the object.voidsetStale(boolean stale) Set the stale status for the object.
- 
Field Details- 
DEFAULTpublic static final int DEFAULTCache the object with the Default TTL- See Also:
 
- 
FOREVERpublic static final int FOREVERDo not expire the object- See Also:
 
- 
createdprotected long createdWhen the object is created.
 
- 
- 
Constructor Details- 
CachedObjectConstructor; sets the object to expire in the default time (30 minutes).- Parameters:
- object- The object you want to cache.
 
- 
CachedObjectConstructor.- Parameters:
- object- The object to cache.
- expires- How long before the object expires, in ms, e.g. 1000 = 1 second.
 
 
- 
- 
Method Details- 
getContentsReturns the cached object.- Returns:
- The cached object.
 
- 
getCreatedpublic long getCreated()Returns the creation time for the object.- Returns:
- When the object was created.
 
- 
getExpirespublic long getExpires()Returns the expiration time for the object.- Returns:
- When the object expires.
 
- 
setExpirespublic void setExpires(long expires) Set the expiration interval for the object.- Parameters:
- expires- Expiration interval in millis ( 1 second = 1000 millis)
 
- 
setStalepublic void setStale(boolean stale) Set the stale status for the object.- Parameters:
- stale- Whether the object is stale or not.
 
- 
isStalepublic boolean isStale()Is the object stale?- Returns:
- True if the object is stale.
 
 
-