casa.event

Class RecurringEvent

java.lang.Object

java.util.Observable

casa.event.AbstractEvent

casa.event.RecurringEvent

All Implemented Interfaces:

Event, Describable, Cloneable, Comparable<AbstractEvent>

Direct Known Subclasses:

RecurringTimeEvent

public abstract class RecurringEvent
extends AbstractEvent

The RecurringEvent abstract class represents an event that does recur. It defines isRecurring() to always return true.

Version:

0.9

Author:

Jason Heard

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	stop

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
RecurringEvent(String newType, PolicyAgentInterface agent) Creates a new NonRecurringEvent class with the specified type.

Method Summary

Modifier and Type	Method and Description
void	cancel() Signals that this event should actually be deleted and not repeated after the next call to delete().
void	delete() Doesn't delete the event unless cancel() has been previously called
boolean	isRecurring() Determines if this event is recurring.
void	start() Indicates that notification of the observers can now occur and queues the event to the agent's event queue.
String	toString()

Methods inherited from class casa.event.AbstractEvent

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

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

stop

private boolean stop

Constructor Detail

RecurringEvent

public RecurringEvent(String newType,
                      PolicyAgentInterface agent)

Creates a new NonRecurringEvent class with the specified type.

Parameters:

newType - the type of the event

agent - the agent that this event will be queued to

Method Detail

isRecurring

public final boolean isRecurring()

Determines if this event is recurring. Since this is a recurring event, this always returns true.

Returns:

true, always.

cancel

public void cancel()

Signals that this event should actually be deleted and not repeated after the next call to delete().

delete

public void delete()

Doesn't delete the event unless cancel() has been previously called

Overrides:

delete in class AbstractEvent

See Also:

AbstractEvent.delete()

start

public void start()

Description copied from interface: Event

Indicates that notification of the observers can now occur and queues the event to the agent's event queue. Before this is called, this event should never call any of its observers EventObserver.notifyEventOccurred(String, Event, Object) method.

toString

public String toString()

Overrides:

toString in class AbstractEvent