akka.testkit

Class TestActorRef<T extends Actor>

java.lang.Object

akka.actor.ActorRef

akka.actor.InternalActorRef

akka.actor.ActorRefWithCell

akka.actor.LocalActorRef

akka.testkit.TestActorRef<T>

All Implemented Interfaces:

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

Direct Known Subclasses:

TestFSMRef

public class TestActorRef<T extends Actor>
extends LocalActorRef

This special ActorRef is exclusively for use during unit testing in a single-threaded environment. Therefore, it overrides the dispatcher to CallingThreadDispatcher and sets the receiveTimeout to None. Otherwise, it acts just like a normal ActorRef. You may retrieve a reference to the underlying actor to test internal logic.

Since:

1.1

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TestActorRef(ActorSystem _system, Props _props, ActorRef _supervisor, java.lang.String name)

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 <T extends Actor> TestActorRef<T>	apply(ActorRef supervisor, scala.reflect.ClassTag<T> t, ActorSystem system)
static <T extends Actor> TestActorRef<T>	apply(ActorRef supervisor, java.lang.String name, scala.reflect.ClassTag<T> t, ActorSystem system)
static <T extends Actor> TestActorRef<T>	apply(scala.reflect.ClassTag<T> t, ActorSystem system)
static <T extends Actor> TestActorRef<T>	apply(scala.Function0<T> factory, scala.reflect.ClassTag<T> evidence$1, ActorSystem system)
static <T extends Actor> TestActorRef<T>	apply(scala.Function0<T> factory, java.lang.String name, scala.reflect.ClassTag<T> evidence$2, ActorSystem system)
static <T extends Actor> TestActorRef<T>	apply(Props props, ActorRef supervisor, ActorSystem system)
static <T extends Actor> TestActorRef<T>	apply(Props props, ActorRef supervisor, java.lang.String name, ActorSystem system)
static <T extends Actor> TestActorRef<T>	apply(Props props, ActorSystem system)
static <T extends Actor> TestActorRef<T>	apply(Props props, java.lang.String name, ActorSystem system)
static <T extends Actor> TestActorRef<T>	apply(java.lang.String name, scala.reflect.ClassTag<T> t, ActorSystem system)
static scala.collection.immutable.Iterable<ActorRef>	children()
static int	compareTo(ActorRef other)
static <T extends Actor> TestActorRef<T>	create(ActorSystem system, Props props) Java API: create a TestActorRef in the given system for the given props, with a random name.
static <T extends Actor> TestActorRef<T>	create(ActorSystem system, Props props, ActorRef supervisor) Java API: create a TestActorRef in the given system for the given props, with the given supervisor and a random name.
static <T extends Actor> TestActorRef<T>	create(ActorSystem system, Props props, ActorRef supervisor, java.lang.String name) Java API: create a TestActorRef in the given system for the given props, with the given supervisor and name.
static <T extends Actor> TestActorRef<T>	create(ActorSystem system, Props props, java.lang.String name) Java API: create a TestActorRef in the given system for the given props, with the given name.
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()
static boolean	isTerminated()
protected ActorCell	newActorCell(ActorSystemImpl system, InternalActorRef ref, Props props, MessageDispatcher dispatcher, InternalActorRef supervisor)
static ActorPath	path()
Props	props()
static ActorRefProvider	provider()
static java.lang.String	randomName()
void	receive(java.lang.Object o) Directly inject messages into actor receive behavior.
void	receive(java.lang.Object o, ActorRef sender) Directly inject messages into actor receive behavior.
static void	restart(java.lang.Throwable cause)
static void	resume(java.lang.Throwable causedByFailure)
static void	sendSystemMessage(SystemMessage message)
static void	start()
static void	stop()
static void	suspend()
static void	tell(java.lang.Object msg, ActorRef sender)
java.lang.String	toString()
static ActorCell	underlying()
T	underlyingActor() Retrieve reference to the underlying actor, where the static type matches the factory used inside the constructor.
ActorRef	unwatch(ActorRef subject) Unregisters this actor from being a death monitor of the provided ActorRef This means that this actor will not get a Terminated()-message when the provided actor is permanently terminated.
ActorRef	watch(ActorRef subject) Registers this actor to be a death monitor of the provided ActorRef This means that this actor will get a Terminated()-message when the provided actor is permanently terminated.
protected static java.lang.Object	writeReplace()

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

TestActorRef

public TestActorRef(ActorSystem _system,
                    Props _props,
                    ActorRef _supervisor,
                    java.lang.String name)

Method Detail

randomName

public static java.lang.String randomName()

apply

public static <T extends Actor> TestActorRef<T> apply(scala.Function0<T> factory,
                                                      scala.reflect.ClassTag<T> evidence$1,
                                                      ActorSystem system)

apply

public static <T extends Actor> TestActorRef<T> apply(scala.Function0<T> factory,
                                                      java.lang.String name,
                                                      scala.reflect.ClassTag<T> evidence$2,
                                                      ActorSystem system)

apply

public static <T extends Actor> TestActorRef<T> apply(Props props,
                                                      ActorSystem system)

apply

public static <T extends Actor> TestActorRef<T> apply(Props props,
                                                      java.lang.String name,
                                                      ActorSystem system)

apply

public static <T extends Actor> TestActorRef<T> apply(Props props,
                                                      ActorRef supervisor,
                                                      ActorSystem system)

apply

public static <T extends Actor> TestActorRef<T> apply(Props props,
                                                      ActorRef supervisor,
                                                      java.lang.String name,
                                                      ActorSystem system)

apply

public static <T extends Actor> TestActorRef<T> apply(scala.reflect.ClassTag<T> t,
                                                      ActorSystem system)

apply

public static <T extends Actor> TestActorRef<T> apply(java.lang.String name,
                                                      scala.reflect.ClassTag<T> t,
                                                      ActorSystem system)

apply

public static <T extends Actor> TestActorRef<T> apply(ActorRef supervisor,
                                                      scala.reflect.ClassTag<T> t,
                                                      ActorSystem system)

apply

public static <T extends Actor> TestActorRef<T> apply(ActorRef supervisor,
                                                      java.lang.String name,
                                                      scala.reflect.ClassTag<T> t,
                                                      ActorSystem system)

create

public static <T extends Actor> TestActorRef<T> create(ActorSystem system,
                                                       Props props,
                                                       ActorRef supervisor,
                                                       java.lang.String name)

Java API: create a TestActorRef in the given system for the given props, with the given supervisor and name.

Parameters:

system - (undocumented)

props - (undocumented)

supervisor - (undocumented)

name - (undocumented)

Returns:

(undocumented)

create

public static <T extends Actor> TestActorRef<T> create(ActorSystem system,
                                                       Props props,
                                                       ActorRef supervisor)

Java API: create a TestActorRef in the given system for the given props, with the given supervisor and a random name.

Parameters:

system - (undocumented)

props - (undocumented)

supervisor - (undocumented)

Returns:

(undocumented)

create

public static <T extends Actor> TestActorRef<T> create(ActorSystem system,
                                                       Props props,
                                                       java.lang.String name)

Java API: create a TestActorRef in the given system for the given props, with the given name.

Parameters:

system - (undocumented)

props - (undocumented)

name - (undocumented)

Returns:

(undocumented)

create

public static <T extends Actor> TestActorRef<T> create(ActorSystem system,
                                                       Props props)

Java API: create a TestActorRef in the given system for the given props, with a random name.

Parameters:

system - (undocumented)

props - (undocumented)

Returns:

(undocumented)

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 Props props()

dispatcher

public MessageDispatcher dispatcher()

newActorCell

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

Overrides:

newActorCell in class LocalActorRef

receive

public void receive(java.lang.Object o)

Directly inject messages into actor receive behavior. Any exceptions thrown will be available to you, while still being able to use become/unbecome.

Parameters:

o - (undocumented)

receive

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

Directly inject messages into actor receive behavior. Any exceptions thrown will be available to you, while still being able to use become/unbecome.

Parameters:

o - (undocumented)

sender - (undocumented)

underlyingActor

public T underlyingActor()

Retrieve reference to the underlying actor, where the static type matches the factory used inside the constructor. Beware that this reference is discarded by the ActorRef upon restarting the actor (should this reference be linked to a supervisor). The old Actor may of course still be used in post-mortem assertions.

Returns:

(undocumented)

watch

public ActorRef watch(ActorRef subject)

Registers this actor to be a death monitor of the provided ActorRef This means that this actor will get a Terminated()-message when the provided actor is permanently terminated.

Parameters:

subject - (undocumented)

Returns:

the same ActorRef that is provided to it, to allow for cleaner invocations

unwatch

public ActorRef unwatch(ActorRef subject)

Unregisters this actor from being a death monitor of the provided ActorRef This means that this actor will not get a Terminated()-message when the provided actor is permanently terminated.

Parameters:

subject - (undocumented)

Returns:

the same ActorRef that is provided to it, to allow for cleaner invocations

toString

public java.lang.String toString()

Overrides:

toString in class ActorRef