com.opensymphony.oscache.base.events
Class ScopeEvent

java.lang.Object
  com.opensymphony.oscache.base.events.CacheEvent
      com.opensymphony.oscache.base.events.ScopeEvent

public final class ScopeEvent
extends CacheEvent

A ScopeEvent is created when an event occurs across one or all scopes. This type of event is only applicable to the ServletCacheAdministrator.

Version:

$Revision: 254 $

Author:

Francois Beauregard

Field Summary

private Date	date Date that the event applies to.
private ScopeEventType	eventType Type of the event.
private int	scope Scope that applies to this event.

Fields inherited from class com.opensymphony.oscache.base.events.CacheEvent

origin

Constructor Summary

ScopeEvent(ScopeEventType eventType, int scope, Date date)
Constructs a scope event object with no specified origin.

ScopeEvent(ScopeEventType eventType, int scope, Date date, String origin)
Constructs a scope event object.

Method Summary

Date	getDate() Retrieve the event date
ScopeEventType	getEventType() Retrieve the type of the event.
int	getScope() Retrieve the scope that applies to the event.

Methods inherited from class com.opensymphony.oscache.base.events.CacheEvent

getOrigin

Methods inherited from class java.lang.Object

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

Field Detail

date

private Date date

Date that the event applies to.

eventType

private ScopeEventType eventType

Type of the event.

scope

private int scope

Scope that applies to this event.

Constructor Detail

ScopeEvent

public ScopeEvent(ScopeEventType eventType,
                  int scope,
                  Date date)

Constructs a scope event object with no specified origin.

Parameters:

eventType - Type of the event.

scope - Scope that applies to the event.

date - Date that the event applies to.

ScopeEvent

public ScopeEvent(ScopeEventType eventType,
                  int scope,
                  Date date,
                  String origin)

Constructs a scope event object.

Parameters:

eventType - Type of the event.

scope - Scope that applies to the event.

date - Date that the event applies to.

origin - The origin of this event.

Method Detail

getDate

public Date getDate()

Retrieve the event date

getEventType

public ScopeEventType getEventType()

Retrieve the type of the event.

getScope

public int getScope()

Retrieve the scope that applies to the event.