akka.actor

Class Props

java.lang.Object

akka.actor.Props

All Implemented Interfaces:

java.io.Serializable, scala.Equals, scala.Product

public final class Props
extends java.lang.Object
implements scala.Product, scala.Serializable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Props.EmptyActor INTERNAL API

Constructor Summary

Constructors

Constructor and Description
Props(Deploy deploy, java.lang.Class<?> clazz, scala.collection.immutable.Seq<java.lang.Object> args)

Method Summary

Modifier and Type	Method and Description
java.lang.Class<? extends Actor>	actorClass() Obtain an upper-bound approximation of the actor class which is going to be created by these Props.
static Props	apply(java.lang.Class<?> clazz, scala.collection.Seq<java.lang.Object> args) Scala API: create a Props given a class and its constructor arguments.
static <T extends Actor> Props	apply(scala.reflect.ClassTag<T> evidence$1) Scala API: Returns a Props that has default values except for "creator" which will be a function that creates an instance of the supplied type using the default constructor.
static <T extends Actor> Props	apply(scala.Function0<T> creator, scala.reflect.ClassTag<T> evidence$2) Scala API: Returns a Props that has default values except for "creator" which will be a function that creates an instance using the supplied thunk.
scala.collection.immutable.Seq<java.lang.Object>	args()
abstract static boolean	canEqual(java.lang.Object that)
java.lang.Class<?>	clazz()
static scala.Function0<Actor>	defaultCreator() The defaultCreator, simply throws an UnsupportedOperationException when applied, which is used when creating a Props
static Deploy	defaultDeploy() The default Deploy instance which is used when creating a Props
static RouterConfig	defaultRoutedProps() The defaultRoutedProps is NoRouter which is used when creating a Props
Deploy	deploy()
java.lang.String	dispatcher() Convenience method for extracting the dispatcher information from the contained Deploy instance.
static Props	empty() A Props instance whose creator will create an actor that doesn't respond to any message
abstract static boolean	equals(java.lang.Object that)
java.lang.String	mailbox() Convenience method for extracting the mailbox information from the contained Deploy instance.
Actor	newActor() INTERNAL API
IndirectActorProducer	producer() INTERNAL API
abstract static int	productArity()
abstract static java.lang.Object	productElement(int n)
static scala.collection.Iterator<java.lang.Object>	productIterator()
static java.lang.String	productPrefix()
RouterConfig	routerConfig() Convenience method for extracting the router configuration from the contained Deploy instance.
Props	withDeploy(Deploy d) Returns a new Props with the specified deployment configuration.
Props	withDispatcher(java.lang.String d) Returns a new Props with the specified dispatcher set.
Props	withMailbox(java.lang.String m) Returns a new Props with the specified mailbox set.
Props	withRouter(RouterConfig r) Returns a new Props with the specified router config set.

Methods inherited from class java.lang.Object

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

Methods inherited from interface scala.Product

$init$, productArity, productElement, productIterator, productPrefix

Methods inherited from interface scala.Equals

canEqual, equals

Constructor Detail

Props

public Props(Deploy deploy,
             java.lang.Class<?> clazz,
             scala.collection.immutable.Seq<java.lang.Object> args)

Method Detail

defaultCreator

public static final scala.Function0<Actor> defaultCreator()

The defaultCreator, simply throws an UnsupportedOperationException when applied, which is used when creating a Props

Returns:

(undocumented)

defaultRoutedProps

public static final RouterConfig defaultRoutedProps()

The defaultRoutedProps is NoRouter which is used when creating a Props

Returns:

(undocumented)

defaultDeploy

public static final Deploy defaultDeploy()

The default Deploy instance which is used when creating a Props

Returns:

(undocumented)

empty

public static final Props empty()

A Props instance whose creator will create an actor that doesn't respond to any message

Returns:

(undocumented)

apply

public static <T extends Actor> Props apply(scala.reflect.ClassTag<T> evidence$1)

Scala API: Returns a Props that has default values except for "creator" which will be a function that creates an instance of the supplied type using the default constructor.

Parameters:

evidence$1 - (undocumented)

Returns:

(undocumented)

apply

public static <T extends Actor> Props apply(scala.Function0<T> creator,
                                            scala.reflect.ClassTag<T> evidence$2)

Scala API: Returns a Props that has default values except for "creator" which will be a function that creates an instance using the supplied thunk.

CAVEAT: Required mailbox type cannot be detected when using anonymous mixin composition when creating the instance. For example, the following will not detect the need for DequeBasedMessageQueueSemantics as defined in Stash:

 'Props(new Actor with Stash { ... })
 

Instead you must create a named class that mixin the trait, e.g. class MyActor extends Actor with Stash.

Parameters:

creator - (undocumented)

evidence$2 - (undocumented)

Returns:

(undocumented)

apply

public static Props apply(java.lang.Class<?> clazz,
                          scala.collection.Seq<java.lang.Object> args)

Scala API: create a Props given a class and its constructor arguments.

Parameters:

clazz - (undocumented)

args - (undocumented)

Returns:

(undocumented)

canEqual

public abstract static boolean canEqual(java.lang.Object that)

equals

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

productElement

public abstract static java.lang.Object productElement(int n)

productArity

public abstract static int productArity()

productIterator

public static scala.collection.Iterator<java.lang.Object> productIterator()

productPrefix

public static java.lang.String productPrefix()

deploy

public Deploy deploy()

clazz

public java.lang.Class<?> clazz()

args

public scala.collection.immutable.Seq<java.lang.Object> args()

producer

public IndirectActorProducer producer()

INTERNAL API

Returns:

(undocumented)

dispatcher

public java.lang.String dispatcher()

Convenience method for extracting the dispatcher information from the contained Deploy instance.

Returns:

(undocumented)

mailbox

public java.lang.String mailbox()

Convenience method for extracting the mailbox information from the contained Deploy instance.

Returns:

(undocumented)

routerConfig

public RouterConfig routerConfig()

Convenience method for extracting the router configuration from the contained Deploy instance.

Returns:

(undocumented)

withDispatcher

public Props withDispatcher(java.lang.String d)

Returns a new Props with the specified dispatcher set.

Parameters:

d - (undocumented)

Returns:

(undocumented)

withMailbox

public Props withMailbox(java.lang.String m)

Returns a new Props with the specified mailbox set.

Parameters:

m - (undocumented)

Returns:

(undocumented)

withRouter

public Props withRouter(RouterConfig r)

Returns a new Props with the specified router config set.

Parameters:

r - (undocumented)

Returns:

(undocumented)

withDeploy

public Props withDeploy(Deploy d)

Returns a new Props with the specified deployment configuration.

Parameters:

d - (undocumented)

Returns:

(undocumented)

actorClass

public java.lang.Class<? extends Actor> actorClass()

Obtain an upper-bound approximation of the actor class which is going to be created by these Props. In other words, the actor factory method will produce an instance of this class or a subclass thereof. This is used by the actor system to select special dispatchers or mailboxes in case dependencies are encoded in the actor type.

Returns:

(undocumented)

newActor

public Actor newActor()

INTERNAL API

Create a new actor instance. This method is only useful when called during actor creation by the ActorSystem, i.e. for user-level code it can only be used within the implementation of IndirectActorProducer.produce().

Returns:

(undocumented)