jasi.sim.basic.event
Class AbstractRepeatingEvent

java.lang.Object
  jasi.sim.basic.value.AbstractSimValueType
      jasi.sim.basic.value.AbstractComparableObject<Event>
          jasi.sim.basic.event.AbstractEventBean
              jasi.sim.basic.event.AbstractRepeatingEvent

All Implemented Interfaces:

Event, SimObject, ExtendedComparable<Event>, SimValue, java.io.Serializable, java.lang.Comparable<Event>

Direct Known Subclasses:

NextLocationEvent, SimpleRepeatingEvent, StatusPrintEvent, TimeStepEvent

public abstract class AbstractRepeatingEvent
extends AbstractEventBean

Basic implementation for all events, that can be repeated. This event will change its time, whenever repeated, but not its priority.

See Also:

Serialized Form

Field Summary

Fields inherited from interface jasi.sim.basic.event.Event

COMPARATOR, DEFAULT_PRIORITY

Constructor Summary

protected	AbstractRepeatingEvent() Constructor for RepeatingEvent.
protected	AbstractRepeatingEvent(Time time) Constructor for RepeatingEvent.
protected	AbstractRepeatingEvent(Time time, EventListener l) Constructor for RepeatingEvent.
protected	AbstractRepeatingEvent(Time time, int priority) Constructor for RepeatingEvent.
protected	AbstractRepeatingEvent(Time time, int priority, EventListener l) Constructor for RepeatingEvent.

Method Summary

void	finish() Finish the repeating of this event.
Time	getEndTime() Returns the end time, when to stop repeating.
Time	getInterval() Returns the interval, to repeat this event.
Event	popped(Calendar calendar) This event was popped from a calendar.
abstract void	repeat() This method is called, when this event is repeated.
void	setEndTime(Time endTime) Sets the end time, when to stop repeating.
void	setInterval(Time interval) Sets the interval, to repeat this event.

Methods inherited from class jasi.sim.basic.event.AbstractEventBean

addEventListener, calendar, compareTo, equals, getEventListeners, getId, getPriority, getTime, hashCode, imported, inform, isInitialized, isPopped, isPushed, pushed, removeEventListener, setId, setPriority, setTime, toString

Methods inherited from class jasi.sim.basic.value.AbstractComparableObject

isEQ, isGE, isGT, isLE, isLT, isNE

Methods inherited from class jasi.sim.basic.value.AbstractSimValueType

getContent

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface jasi.sim.basic.value.ExtendedComparable

isEQ, isGE, isGT, isLE, isLT, isNE

Constructor Detail

AbstractRepeatingEvent

protected AbstractRepeatingEvent(Time time,
                                 int priority)

Constructor for RepeatingEvent.

Parameters:

time -

priority -

AbstractRepeatingEvent

protected AbstractRepeatingEvent(Time time)

Constructor for RepeatingEvent.

Parameters:

time -

AbstractRepeatingEvent

protected AbstractRepeatingEvent()

Constructor for RepeatingEvent.

AbstractRepeatingEvent

protected AbstractRepeatingEvent(Time time,
                                 int priority,
                                 EventListener l)

Constructor for RepeatingEvent.

Parameters:

time -

priority -

l -

AbstractRepeatingEvent

protected AbstractRepeatingEvent(Time time,
                                 EventListener l)

Constructor for RepeatingEvent.

Parameters:

time -

l -

Method Detail

repeat

public abstract void repeat()

This method is called, when this event is repeated. Extending classes can change the event's state, the interval and the end time for repeating this event. The event listeners have to be set again!

finish

public final void finish()

Finish the repeating of this event.

popped

public final Event popped(Calendar calendar)

This event was popped from a calendar. All its listeners will be informed to handle or execute this event.

Specified by:

popped in interface Event

Overrides:

popped in class AbstractEventBean

Parameters:

calendar - The calendar which popped this event.

Returns:

This popped event.

getInterval

public final Time getInterval()

Returns the interval, to repeat this event.

Returns:

The time interval.

setInterval

public final void setInterval(Time interval)

Sets the interval, to repeat this event.

Parameters:

interval - The time interval to set. If null, repeating will be stopped.

getEndTime

public final Time getEndTime()

Returns the end time, when to stop repeating.

Returns:

The end time.

setEndTime

public final void setEndTime(Time endTime)

Sets the end time, when to stop repeating.

Parameters:

endTime - The end time to set. If null, repeating will be stopped.