akka.testkit

Class TestFSMRef<S,D,T extends Actor>

java.lang.Object

akka.actor.ActorRef

akka.actor.InternalActorRef

akka.actor.ActorRefWithCell

akka.actor.LocalActorRef

akka.testkit.TestActorRef<T>

akka.testkit.TestFSMRef<S,D,T>

All Implemented Interfaces:

ActorRefScope, LocalRef, ScalaActorRef, java.io.Serializable, java.lang.Comparable<ActorRef>

public class TestFSMRef<S,D,T extends Actor>
extends TestActorRef<T>

This is a specialized form of the TestActorRef with support for querying and setting the state of a FSM. Use a LoggingFSM with this class if you also need to inspect event traces.

 val fsm = TestFSMRef(new Actor with LoggingFSM[Int, Null] {
     override def logDepth = 12
     startWith(1, null)
     when(1) {
       case Ev("hello") => goto(2)
     }
     when(2) {
       case Ev("world") => goto(1)
     }
   }
 assert (fsm.stateName == 1)
 fsm ! "hallo"
 assert (fsm.stateName == 2)
 assert (fsm.underlyingActor.getLog == IndexedSeq(FSMLogEntry(1, null, "hallo")))
 

Since:

1.2

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TestFSMRef(ActorSystem system, Props props, ActorRef supervisor, java.lang.String name, scala.Predef.$less$colon$less<T,FSM<S,D>> ev)

Method Summary

Modifier and Type	Method and Description
static void	$bang(java.lang.Object message, ActorRef sender)
static ActorRef	$bang$default$2(java.lang.Object message)
protected static ActorContext	actorContext()
static <S,D,T extends Actor> TestFSMRef<S,D,T>	apply(scala.Function0<T> factory, ActorRef supervisor, scala.reflect.ClassTag<T> evidence$4, scala.Predef.$less$colon$less<T,FSM<S,D>> ev, ActorSystem system)
static <S,D,T extends Actor> TestFSMRef<S,D,T>	apply(scala.Function0<T> factory, ActorRef supervisor, java.lang.String name, scala.reflect.ClassTag<T> evidence$3, scala.Predef.$less$colon$less<T,FSM<S,D>> ev, ActorSystem system)
static <S,D,T extends Actor> TestFSMRef<S,D,T>	apply(scala.Function0<T> factory, scala.reflect.ClassTag<T> evidence$1, scala.Predef.$less$colon$less<T,FSM<S,D>> ev, ActorSystem system)
static <S,D,T extends Actor> TestFSMRef<S,D,T>	apply(scala.Function0<T> factory, java.lang.String name, scala.reflect.ClassTag<T> evidence$2, scala.Predef.$less$colon$less<T,FSM<S,D>> ev, ActorSystem system)
void	cancelTimer(java.lang.String name) Proxy for FSM.cancelTimer(java.lang.String).
static scala.collection.immutable.Iterable<ActorRef>	children()
static int	compareTo(ActorRef other)
static MessageDispatcher	dispatcher()
static boolean	equals(java.lang.Object that)
static void	forward(java.lang.Object message, ActorContext context)
static InternalActorRef	getChild(scala.collection.Iterator<java.lang.String> names)
static InternalActorRef	getParent()
static InternalActorRef	getSingleChild(java.lang.String name)
static int	hashCode()
abstract static boolean	isLocal()
boolean	isStateTimerActive() Proxy for FSM.isStateTimerActive().
static boolean	isTerminated()
boolean	isTimerActive(java.lang.String name) Proxy for FSM.isStateTimerActive().
protected static ActorCell	newActorCell(ActorSystemImpl system, InternalActorRef ref, Props props, MessageDispatcher dispatcher, InternalActorRef supervisor)
static ActorPath	path()
static Props	props()
static ActorRefProvider	provider()
static void	receive(java.lang.Object o)
static void	receive(java.lang.Object o, ActorRef sender)
static void	restart(java.lang.Throwable cause)
static void	resume(java.lang.Throwable causedByFailure)
static void	sendSystemMessage(SystemMessage message)
void	setState(S stateName, D stateData, scala.concurrent.duration.FiniteDuration timeout, scala.Option<FSM.Reason> stopReason) Change FSM state; any value left out defaults to the current FSM state (timeout defaults to None).
void	setTimer(java.lang.String name, java.lang.Object msg, scala.concurrent.duration.FiniteDuration timeout, boolean repeat) Proxy for FSM.setTimer(java.lang.String, java.lang.Object, scala.concurrent.duration.FiniteDuration, boolean).
static void	start()
D	stateData() Get current state data of this FSM.
S	stateName() Get current state name of this FSM.
static void	stop()
static void	suspend()
static void	tell(java.lang.Object msg, ActorRef sender)
static java.lang.String	toString()
static ActorCell	underlying()
static T	underlyingActor()
static ActorRef	unwatch(ActorRef subject)
static ActorRef	watch(ActorRef subject)
protected static java.lang.Object	writeReplace()

Methods inherited from class akka.testkit.TestActorRef

apply, apply, apply, apply, apply, apply, apply, apply, apply, apply, create, create, create, create, dispatcher, newActorCell, props, randomName, receive, receive, toString, underlyingActor, unwatch, watch

Methods inherited from class akka.actor.LocalActorRef

actorContext, children, getChild, getParent, getSingleChild, isTerminated, path, provider, restart, resume, sendSystemMessage, start, stop, suspend, underlying, writeReplace

Methods inherited from class akka.actor.InternalActorRef

isLocal

Methods inherited from class akka.actor.ActorRef

compareTo, equals, forward, hashCode, noSender, tell

Methods inherited from class java.lang.Object

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

Methods inherited from interface akka.actor.LocalRef

isLocal

Constructor Detail

TestFSMRef

public TestFSMRef(ActorSystem system,
                  Props props,
                  ActorRef supervisor,
                  java.lang.String name,
                  scala.Predef.$less$colon$less<T,FSM<S,D>> ev)

Method Detail

apply

public static <S,D,T extends Actor> TestFSMRef<S,D,T> apply(scala.Function0<T> factory,
                                                            scala.reflect.ClassTag<T> evidence$1,
                                                            scala.Predef.$less$colon$less<T,FSM<S,D>> ev,
                                                            ActorSystem system)

apply

public static <S,D,T extends Actor> TestFSMRef<S,D,T> apply(scala.Function0<T> factory,
                                                            java.lang.String name,
                                                            scala.reflect.ClassTag<T> evidence$2,
                                                            scala.Predef.$less$colon$less<T,FSM<S,D>> ev,
                                                            ActorSystem system)

apply

public static <S,D,T extends Actor> TestFSMRef<S,D,T> apply(scala.Function0<T> factory,
                                                            ActorRef supervisor,
                                                            java.lang.String name,
                                                            scala.reflect.ClassTag<T> evidence$3,
                                                            scala.Predef.$less$colon$less<T,FSM<S,D>> ev,
                                                            ActorSystem system)

apply

public static <S,D,T extends Actor> TestFSMRef<S,D,T> apply(scala.Function0<T> factory,
                                                            ActorRef supervisor,
                                                            scala.reflect.ClassTag<T> evidence$4,
                                                            scala.Predef.$less$colon$less<T,FSM<S,D>> ev,
                                                            ActorSystem system)

compareTo

public static final int compareTo(ActorRef other)

tell

public static final void tell(java.lang.Object msg,
                              ActorRef sender)

forward

public static void forward(java.lang.Object message,
                           ActorContext context)

hashCode

public static final int hashCode()

equals

public static final boolean equals(java.lang.Object that)

isLocal

public abstract static boolean isLocal()

path

public static ActorPath path()

actorContext

protected static ActorContext actorContext()

isTerminated

public static boolean isTerminated()

start

public static void start()

suspend

public static void suspend()

resume

public static void resume(java.lang.Throwable causedByFailure)

stop

public static void stop()

getParent

public static InternalActorRef getParent()

provider

public static ActorRefProvider provider()

children

public static scala.collection.immutable.Iterable<ActorRef> children()

getSingleChild

public static InternalActorRef getSingleChild(java.lang.String name)

getChild

public static InternalActorRef getChild(scala.collection.Iterator<java.lang.String> names)

underlying

public static ActorCell underlying()

sendSystemMessage

public static void sendSystemMessage(SystemMessage message)

$bang

public static void $bang(java.lang.Object message,
                         ActorRef sender)

restart

public static void restart(java.lang.Throwable cause)

writeReplace

protected static java.lang.Object writeReplace()
                                        throws java.io.ObjectStreamException

Throws:

java.io.ObjectStreamException

$bang$default$2

public static ActorRef $bang$default$2(java.lang.Object message)

props

public static Props props()

dispatcher

public static MessageDispatcher dispatcher()

newActorCell

protected static ActorCell newActorCell(ActorSystemImpl system,
                                        InternalActorRef ref,
                                        Props props,
                                        MessageDispatcher dispatcher,
                                        InternalActorRef supervisor)

receive

public static void receive(java.lang.Object o)

receive

public static void receive(java.lang.Object o,
                           ActorRef sender)

underlyingActor

public static T underlyingActor()

watch

public static ActorRef watch(ActorRef subject)

unwatch

public static ActorRef unwatch(ActorRef subject)

toString

public static java.lang.String toString()

stateName

public S stateName()

Get current state name of this FSM.

Returns:

(undocumented)

stateData

public D stateData()

Get current state data of this FSM.

Returns:

(undocumented)

setState

public void setState(S stateName,
                     D stateData,
                     scala.concurrent.duration.FiniteDuration timeout,
                     scala.Option<FSM.Reason> stopReason)

Change FSM state; any value left out defaults to the current FSM state (timeout defaults to None). This method is directly equivalent to a corresponding transition initiated from within the FSM, including timeout and stop handling.

Parameters:

stateName - (undocumented)

stateData - (undocumented)

timeout - (undocumented)

stopReason - (undocumented)

setTimer

public void setTimer(java.lang.String name,
                     java.lang.Object msg,
                     scala.concurrent.duration.FiniteDuration timeout,
                     boolean repeat)

Proxy for FSM.setTimer(java.lang.String, java.lang.Object, scala.concurrent.duration.FiniteDuration, boolean).

Parameters:

name - (undocumented)

msg - (undocumented)

timeout - (undocumented)

repeat - (undocumented)

cancelTimer

public void cancelTimer(java.lang.String name)

Proxy for FSM.cancelTimer(java.lang.String).

Parameters:

name - (undocumented)

isTimerActive

public boolean isTimerActive(java.lang.String name)

Proxy for FSM.isStateTimerActive().

Parameters:

name - (undocumented)

Returns:

(undocumented)

isStateTimerActive

public boolean isStateTimerActive()

Proxy for FSM.isStateTimerActive().

Returns:

(undocumented)