| java.lang.Object
 com.opensymphony.oscache.base.events.CacheEvent
com.opensymphony.oscache.base.events.CachewideEvent
| CachewideEvent | | final public class CachewideEvent extends CacheEvent (Code) | | A CachewideEvent represents and event that occurs on
the the entire cache, eg a cache flush or clear.
version:
$Revision: 254 $
author:
Chris Miller |
| Constructor Summary | |
| public | CachewideEvent(Cache cache, Date date, String origin)
Constructs a cachewide event with the specified origin.
Parameters:
cache - The cache map that the event occurred on.
Parameters:
date - The date/time that this cachewide event is scheduled for(eg, the date that the cache is to be flushed).
Parameters:
origin - An optional tag that can be attached to the event tospecify the event's origin. |
| Method Summary | |
| public Cache | getCache()
Retrieve the cache map that the event occurred on. | | public Date | getDate()
Retrieve the date/time that the cache flush is scheduled for. |
| CachewideEvent | | public CachewideEvent(Cache cache, Date date, String origin)(Code) | | Constructs a cachewide event with the specified origin.
Parameters:
cache - The cache map that the event occurred on.
Parameters:
date - The date/time that this cachewide event is scheduled for(eg, the date that the cache is to be flushed).
Parameters:
origin - An optional tag that can be attached to the event tospecify the event's origin. This is useful to prevent events from beingfired recursively in some situations, such as when an event handlercauses another event to be fired. |
| getCache | | public Cache getCache()(Code) | | Retrieve the cache map that the event occurred on.
|
| getDate | | public Date getDate()(Code) | | Retrieve the date/time that the cache flush is scheduled for.
|
| Methods inherited from com.opensymphony.oscache.base.events.CacheEvent | public String getOrigin()(Code)(Java Doc)
|
|
|