casa.event

Class TimeEvent

java.lang.Object

java.util.Observable

casa.event.AbstractEvent

casa.event.NonRecurringEvent

casa.event.TimeEvent

All Implemented Interfaces:

Event, Describable, Cloneable, Comparable<AbstractEvent>

public class TimeEvent
extends NonRecurringEvent

TimeEvent is a non-recurring event that occurs at a specified time. This time is given to the constructor and does not change over the lifetime of the event. The time is given in the same format as System.currentTimeMillis(). If the time that the event occurs is before start() is called, the event occurs as soon as it is called.

Version:

0.9

Author:

Jason Heard

See Also:

System.currentTimeMillis()

Field Summary

Fields

Modifier and Type	Field and Description
private EventTask	task Recorded TimerTask needed if this TimeEvent is canceled.
private long	time The time the event occurs.
protected static Timer	TIMER This is a shared Timer object that is used by all TimeEvents to schedule the activations of events.

Fields inherited from class casa.event.AbstractEvent

agent, fired, id, priority, queueTime

Fields inherited from interface casa.event.Event

DEFAULT_PRIORITY, FIRE_EVENT, HIGHEST_PRIORITY

Constructor Summary

Constructors

Constructor and Description
TimeEvent(String newType, PolicyAgentInterface agent, long newTime) Creates a new TimeEvent that occurs at the given time.

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancels the timer task so it will not get queued for execution
void	start() Starts the timer so that this event can occur.

Methods inherited from class casa.event.NonRecurringEvent

isRecurring

Methods inherited from class casa.event.AbstractEvent

clone, compareTo, delete, fireEvent, getEventType, getID, getOwnerConversationID, getParameter, getPriority, getQueueTime, hasFired, keySet, setOwnerConversationID, setParameter, setParameters, setPriority, setQueueTime, toString

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

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

Methods inherited from interface casa.event.Event

addObserver, countObservers, deleteObserver

Field Detail

TIMER

protected static final Timer TIMER

This is a shared Timer object that is used by all TimeEvents to schedule the activations of events. By sharing the timer object, all timer events use only a single thread.

time

private final long time

The time the event occurs. The time is given in the same format as System.currentTimeMillis().

task

private EventTask task

Recorded TimerTask needed if this TimeEvent is canceled. Only instantiated after start() is executed.

Constructor Detail

TimeEvent

public TimeEvent(String newType,
                 PolicyAgentInterface agent,
                 long newTime)

Creates a new TimeEvent that occurs at the given time.

Parameters:

newType - The type of the new event.

agent - The agent that this event will be queued to.

newTime - The time when this event should occur.

Method Detail

start

public void start()

Starts the timer so that this event can occur. This uses Timer.schedule(TimerTask, Date) to schedule the event.

Specified by:

start in interface Event

Overrides:

start in class NonRecurringEvent

cancel

public void cancel()

Cancels the timer task so it will not get queued for execution