net.jinx.action
Class ActorEvent

java.lang.Object
  net.jinx.action.ActorEvent

Direct Known Subclasses:

ClockEvent, ClockStateEvent

public class ActorEvent
extends java.lang.Object

This is the base class for all events that are passed between Actors. ActorEvent objects should only be mutable (changeable) until they pass through the sendEvent() methods of Actor. Until then, the return value of getSource() will be null.

Attempts to alter the event while the return value of getSource() isn't null should throw java.lang.IllegalStateException.

API Stability: Stable.

Constructor Summary

ActorEvent()
Constructs an ActorEvent.

Method Summary

Actor

getSource() Provides the source Actor that this ActorEvent originated from.

Methods inherited from class java.lang.Object

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

Constructor Detail

ActorEvent

public ActorEvent()

Constructs an ActorEvent.

Method Detail

getSource

public Actor getSource()

Provides the source Actor that this ActorEvent originated from. This will initially be null. That will change once an ActorEvent has passed through the sendEvent(String, ActorEvent) method of Actor.

Returns:

the source Actor. This can be null if the event has not yet been sent off from an Actor.