io.vlingo.xoom.actors

Class World

java.lang.Object

io.vlingo.xoom.actors.World

All Implemented Interfaces:

Registrar

public final class World
extends Object
implements Registrar

The World of the actor runtime through which all Stage and Actor instances are created and run. All plugins and all default facilities are registered through the World.

Field Summary

Fields

Modifier and Type	Field and Description
static long	HIGH_ROOT_ID

Method Summary

Modifier and Type	Method and Description
Protocols	actorFor(Class<?>[] protocols, Class<? extends Actor> type, Object... parameters) Answers a Protocols that provides one or more supported protocols for the newly created Actor according to definition.
Protocols	actorFor(Class<?>[] protocols, Definition definition) Answers a Protocols that provides one or more supported protocols for the newly created Actor according to definition.
<T,A extends Actor> T	actorFor(Class<T> protocol, Class<? extends Actor> type, ActorInstantiator<A> instantiator) Answers the T protocol of the newly created Actor that implements the protocol.
<T> T	actorFor(Class<T> protocol, Class<? extends Actor> type, Object... parameters) Answers the T protocol of the newly created Actor that implements the protocol.
<T> T	actorFor(Class<T> protocol, Definition definition) Answers the T protocol of the newly created Actor that is defined by the parameters of definition that implements the protocol.
AddressFactory	addressFactory() Answers the AddressFactory for this World.
CompletesEventually	completesFor(Address address, Returns<Object> clientReturns) Answers a CompletesEventually instance identified by address that backs the clientReturns.
<T> CompletesEventually	completesFor(Returns<T> clientReturns) Answers a new CompletesEventually instance that backs the clientReturns.
Configuration	configuration() Answers the Configuration for this World.
DeadLetters	deadLetters() Answers the DeadLetters for this World, which is backed by an Actor.
Logger	defaultLogger() Answers the default Logger that is registered with this World.
Actor	defaultParent() Answers the Actor that serves as the default parent for this World.
Supervisor	defaultSupervisor() Answers the Supervisor protocol for sending messages to the default supervisor.
boolean	isTerminated() Answers whether or not this World has been terminated or is in the process of termination.
Logger	logger(String name) Answers the Logger named with name, or null of it does not exist.
String	name() Answers the String name of this World.
void	register(String name, boolean isDefault, LoggerProvider loggerProvider) Registers the LoggerProvider plugin by name.
void	register(String name, boolean isDefault, MailboxProvider mailboxProvider) Registers the MailboxProvider plugin by name.
void	register(String name, CompletesEventuallyProvider completesEventuallyProvider) Registers the CompletesEventuallyProvider plugin by name.
void	registerCommonSupervisor(String stageName, String name, Class<?> supervisedProtocol, Class<? extends Actor> supervisorClass) Registers the supervisorClass plugin by name that will supervise all Actors that implement the supervisedProtocol.
void	registerCompletesEventuallyProviderKeeper(CompletesEventuallyProviderKeeper keeper) Registers the CompletesEventuallyProviderKeeper plugin.
void	registerDefaultSupervisor(String stageName, String name, Class<? extends Actor> supervisorClass) Registers the supervisorClass plugin by name that will serve as the default supervise for all Actors that are not supervised by a specific supervisor.
void	registerDynamic(String name, Object value) Registers the dynamic value with the name key.
void	registerLoggerProviderKeeper(LoggerProviderKeeper keeper) Registers the LoggerProviderKeeper plugin.
void	registerMailboxProviderKeeper(MailboxProviderKeeper keeper) Registers the MailboxProviderKeeper plugin.
<DEPENDENCY> DEPENDENCY	resolveDynamic(String name, Class<DEPENDENCY> anyDependencyClass) Answers the DEPENDENCY instance of the name named dependency.
Stage	stage() Answers the default Stage, which is the Stage created when this World was started.
Stage	stageNamed(String name) Answers the Stage named by name, or the newly created Stage instance named by name if the Stage does not already exist.
Stage	stageNamed(String name, Class<? extends Stage> stageType, AddressFactory addressFactory) Answers the Stage named by name, or the newly created Stage instance named by name if the Stage does not already exist.
static World	start(String name) Answers a new World with the given name and that is configured with the contents of the xoom-actors.properties file.
static World	start(String name, Configuration configuration) Answers a new World with the given name and that is configured with the contents of the configuration.
static World	start(String name, Properties properties) Answers a new World with the given name and that is configured with the contents of the properties.
static World	startWithDefaults(String name) Answers a new World with the given name and that is configured with the contents of the default Configuration of sensible settings.
void	terminate() Initiates the World terminate process if the process has not already been initiated.
World	world() Answers this World instance.

Methods inherited from class java.lang.Object

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

Field Detail

HIGH_ROOT_ID

public static final long HIGH_ROOT_ID

See Also:

Constant Field Values

Method Detail

start

public static World start(String name)

Answers a new World with the given name and that is configured with the contents of the xoom-actors.properties file.

Parameters:

name - the String name to assign to the new World instance

Returns:

World

start

public static World start(String name,
                          Properties properties)

Answers a new World with the given name and that is configured with the contents of the properties.

Parameters:

name - the String name to assign to the new World instance

properties - the java.util.Properties used for configuration

Returns:

World

start

public static World start(String name,
                          Configuration configuration)

Answers a new World with the given name and that is configured with the contents of the configuration.

Parameters:

name - the String name to assign to the new World instance

configuration - the Configuration used for configuration

Returns:

World

startWithDefaults

public static World startWithDefaults(String name)

Answers a new World with the given name and that is configured with the contents of the default Configuration of sensible settings.

Parameters:

name - the String name to assign to the new World instance

Returns:

World

actorFor

public <T,A extends Actor> T actorFor(Class<T> protocol,
                                      Class<? extends Actor> type,
                                      ActorInstantiator<A> instantiator)

Answers the T protocol of the newly created Actor that implements the protocol.

Type Parameters:

T - the protocol type

A - the Actor type

Parameters:

protocol - the Class<T> protocol

type - the Class<? extends Actor> of the Actor to create

instantiator - the ActorInstantiator<A> used to instantiate the Actor

Returns:

T

actorFor

public <T> T actorFor(Class<T> protocol,
                      Class<? extends Actor> type,
                      Object... parameters)

Answers the T protocol of the newly created Actor that implements the protocol.

Type Parameters:

T - the protocol type

Parameters:

protocol - the Class<T> protocol

type - the Class<? extends Actor> of the Actor to create

parameters - the Object[] of constructor parameters

Returns:

T

actorFor

public <T> T actorFor(Class<T> protocol,
                      Definition definition)

Answers the T protocol of the newly created Actor that is defined by the parameters of definition that implements the protocol.

Type Parameters:

T - the protocol type

Parameters:

protocol - the Class<T> protocol that the Actor supports

definition - the Definition providing parameters to the Actor

Returns:

T

actorFor

public Protocols actorFor(Class<?>[] protocols,
                          Class<? extends Actor> type,
                          Object... parameters)

Answers a Protocols that provides one or more supported protocols for the newly created Actor according to definition.

Parameters:

protocols - the Class<?>[] array of protocols that the Actor supports

type - the Class<? extends Actor> of the Actor to create

parameters - the Object[] of constructor parameters

Returns:

Protocols

actorFor

public Protocols actorFor(Class<?>[] protocols,
                          Definition definition)

Answers a Protocols that provides one or more supported protocols for the newly created Actor according to definition.

Parameters:

protocols - the Class<?>[] array of protocols that the Actor supports

definition - the Definition providing parameters to the Actor

Returns:

Protocols

addressFactory

public AddressFactory addressFactory()

Answers the AddressFactory for this World.

Returns:

AddressFactory

configuration

public Configuration configuration()

Answers the Configuration for this World.

Returns:

Configuration

deadLetters

public DeadLetters deadLetters()

Answers the DeadLetters for this World, which is backed by an Actor. Interested parties may register for notifications as a DeadLettersListener via the DeadLetters protocol.

Returns:

DeadLetters

completesFor

public <T> CompletesEventually completesFor(Returns<T> clientReturns)

Answers a new CompletesEventually instance that backs the clientReturns. This manages the Returns using the CompletesEventually plugin Actor pool.

Type Parameters:

T - the type of the Returns

Parameters:

clientReturns - the CompletesEventually allocated for eventual completion of clientReturns

Returns:

CompletesEventually

completesFor

public CompletesEventually completesFor(Address address,
                                        Returns<Object> clientReturns)

Answers a CompletesEventually instance identified by address that backs the clientReturns. This manages the Returns using the CompletesEventually plugin Actor pool.

Parameters:

address - the Address of the CompletesEventually actor to reuse

clientReturns - the CompletesEventually allocated for eventual completion of clientReturns

Returns:

CompletesEventually

defaultLogger

public Logger defaultLogger()

Answers the default Logger that is registered with this World. The Logger protocol is implemented by an Actor such that all logging is asynchronous.

Returns:

Logger

defaultParent

public Actor defaultParent()

Answers the Actor that serves as the default parent for this World. Unless overridden using Configuration (e.g. Properties or fluent Configuration) the default parent is the single PublicRootActor.

Returns:

Actor

defaultSupervisor

public Supervisor defaultSupervisor()

Answers the Supervisor protocol for sending messages to the default supervisor. Unless overridden using Configuration (e.g. Properties or fluent Configuration) the default supervisor is the single PublicRootActor.

Returns:

Supervisor

logger

public Logger logger(String name)

Answers the Logger named with name, or null of it does not exist.

Parameters:

name - the String name of the Logger

Returns:

Logger

name

public String name()

Answers the String name of this World.

Returns:

String

register

public void register(String name,
                     CompletesEventuallyProvider completesEventuallyProvider)

Registers the CompletesEventuallyProvider plugin by name.

Specified by:

register in interface Registrar

Parameters:

name - the String name of the CompletesEventuallyProvider to register

completesEventuallyProvider - the CompletesEventuallyProvider to register

register

public void register(String name,
                     boolean isDefault,
                     LoggerProvider loggerProvider)

Registers the LoggerProvider plugin by name.

Specified by:

register in interface Registrar

Parameters:

name - the String name of the LoggerProvider to register

loggerProvider - the LoggerProvider to register

register

public void register(String name,
                     boolean isDefault,
                     MailboxProvider mailboxProvider)

Registers the MailboxProvider plugin by name.

Specified by:

register in interface Registrar

Parameters:

name - the String name of the MailboxProvider to register

mailboxProvider - the MailboxProvider to register

registerCommonSupervisor

public void registerCommonSupervisor(String stageName,
                                     String name,
                                     Class<?> supervisedProtocol,
                                     Class<? extends Actor> supervisorClass)

Registers the supervisorClass plugin by name that will supervise all Actors that implement the supervisedProtocol.

Specified by:

registerCommonSupervisor in interface Registrar

Parameters:

stageName - the String name of the Stage in which the supervisorClass is to be registered

name - the String name of the supervisor to register

supervisedProtocol - the protocol of Class<?> for which the supervisor will supervise

supervisorClass - the Class<? extends Actor> to register as a supervisor

registerDefaultSupervisor

public void registerDefaultSupervisor(String stageName,
                                      String name,
                                      Class<? extends Actor> supervisorClass)

Registers the supervisorClass plugin by name that will serve as the default supervise for all Actors that are not supervised by a specific supervisor.

Specified by:

registerDefaultSupervisor in interface Registrar

Parameters:

stageName - the String name of the Stage in which the supervisorClass is to be registered

name - the String name of the supervisor to register

supervisorClass - the Class<? extends Actor> to register as a supervisor

registerCompletesEventuallyProviderKeeper

public void registerCompletesEventuallyProviderKeeper(CompletesEventuallyProviderKeeper keeper)

Registers the CompletesEventuallyProviderKeeper plugin.

Specified by:

registerCompletesEventuallyProviderKeeper in interface Registrar

Parameters:

keeper - the CompletesEventuallyProviderKeeper to register

registerLoggerProviderKeeper

public void registerLoggerProviderKeeper(LoggerProviderKeeper keeper)

Registers the LoggerProviderKeeper plugin.

Specified by:

registerLoggerProviderKeeper in interface Registrar

Parameters:

keeper - the LoggerProviderKeeper to register

registerMailboxProviderKeeper

public void registerMailboxProviderKeeper(MailboxProviderKeeper keeper)

Registers the MailboxProviderKeeper plugin.

Specified by:

registerMailboxProviderKeeper in interface Registrar

Parameters:

keeper - the MailboxProviderKeeper to register

registerDynamic

public void registerDynamic(String name,
                            Object value)

Registers the dynamic value with the name key. The value cannot not be replaced by a subsequent registration using the same name.

Parameters:

name - the String name of the dynamic dependencies

value - the Object to register

resolveDynamic

public <DEPENDENCY> DEPENDENCY resolveDynamic(String name,
                                              Class<DEPENDENCY> anyDependencyClass)

Answers the DEPENDENCY instance of the name named dependency.

Type Parameters:

DEPENDENCY - the dependency type

Parameters:

name - the String name of the dynamic dependency

anyDependencyClass - the Class<DEPENDENCY>

Returns:

the DEPENDENCY instance

stage

public Stage stage()

Answers the default Stage, which is the Stage created when this World was started.

Returns:

Stage

stageNamed

public Stage stageNamed(String name)

Answers the Stage named by name, or the newly created Stage instance named by name if the Stage does not already exist.

Parameters:

name - the String name of the Stage to answer

Returns:

Stage

stageNamed

public Stage stageNamed(String name,
                        Class<? extends Stage> stageType,
                        AddressFactory addressFactory)

Answers the Stage named by name, or the newly created Stage instance named by name if the Stage does not already exist.

Parameters:

name - the String name of the Stage to answer

stageType - the Class<? extends Stage>

addressFactory - the AddressFactory of the Stage if not existing

Returns:

Stage

isTerminated

public boolean isTerminated()

Answers whether or not this World has been terminated or is in the process of termination.

Returns:

boolean

terminate

public void terminate()

Initiates the World terminate process if the process has not already been initiated.

world

public World world()

Answers this World instance.

Specified by:

world in interface Registrar

Returns:

World