Actor (vlingo-actors 1.7.5 API)

java.lang.Object
- io.vlingo.xoom.actors.Actor

All Implemented Interfaces:

Relocatable, Startable, Stoppable, TestStateView

Direct Known Subclasses:

CompletesEventuallyActor, DeadLettersActor, DefaultSupervisor, DefaultSupervisorOverride, DirectoryEvictor, DirectoryScannerActor, PrivateRootActor, PublicRootActor, Router, Slf4jLoggerActor
```
public abstract class Actor
extends Object
implements Startable, Stoppable, Relocatable, TestStateView
```
The abstract base class of all concrete Actor types. This base provides common facilities and life cycle processing for all Actor types.

Constructor Summary

Constructors
Modifier Constructor and Description

protected Actor()
Initializes the newly created Actor.

Constructors
Modifier	Constructor and Description
`protected`	`Actor()` Initializes the newly created `Actor`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Address`	`address()` Answers the `address` of this `Actor`.
`protected void`	`afterRestart(Throwable reason)` The message delivered after the `Actor` has been restarted by its supervisor due to an exception.
`protected void`	`afterStop()` The message delivered after the `Actor` has fully stopped.
`protected <R> io.vlingo.xoom.common.Completes<R>`	`answerFrom(io.vlingo.xoom.common.Completes<R> eventualOutcome)` Answer my internal `Completes<R>` from `completes()` after preparing for the `eventualOutcome` to be set in my `completesEventually()`.
`protected void`	`beforeRestart(Throwable reason)` The message delivered before the `Actor` has been restarted by its supervisor due to an exception.
`protected void`	`beforeResume(Throwable reason)` The message delivered before the `Actor` has been resumed by its supervisor due to an exception.
`protected void`	`beforeStart()` The message delivered before the `Actor` has fully started.
`protected Protocols`	`childActorFor(Class<?>[] protocols, Definition definition)` Answers the `Protocols` for the child `Actor` to be created by this parent `Actor`.
`protected <T> T`	`childActorFor(Class<T> protocol, Definition definition)` Answers the `T` protocol for the child `Actor` to be created by this parent `Actor`.
`protected <T> CompletableFuture<T>`	`completableFuture()` Answers the `CompletableFuture<T>` instance for this `Actor`, or throws `IllegalStateException` if the behavior of the currently delivered `Message` does not answer a `CompletableFuture<T>`.
`protected <T> io.vlingo.xoom.common.Completes<T>`	`completes()` Answers the `Completes<T>` instance for this `Actor`, or throws `IllegalStateException` if the behavior of the currently delivered `Message` does not answer a `Completes<T>`.
`protected CompletesEventually`	`completesEventually()` Answers a `CompletesEventually` if the behavior of the currently delivered `Message` does answers a `Completes<T>`.
`void`	`conclude()` Concludes the receiver, eventually causing it to receive a stop() message.
`DeadLetters`	`deadLetters()` Answers the `DeadLetters` for this `Actor`.
`Definition`	`definition()` Answers the `Definition` of this `Actor`.
`protected void`	`disperseStowedMessages()` Starts the process of dispersing any messages stowed for this `Actor`.
`boolean`	`equals(Object other)` Answers whether or not this `Actor` is equal to `other`.
`protected <T> Future<T>`	`future(Callable<T> callable)` Answers the `Future<T>` instance for this `Actor`, or throws `IllegalStateException` if the behavior of the currently delivered `Message` does not answer a `Future<T>`.
`int`	`hashCode()` Answers the `int` hash code of this `Actor`.
`boolean`	`isStopped()` Answers whether or not this `Actor` has been stopped or is in the process or stopping.
`protected Logger`	`logger()` Answers the `Logger` of this `Actor`.
`protected <T> T`	`parentAs(Class<T> protocol)` Answers the parent of this `Actor` as the `T` protocol.
`io.vlingo.xoom.common.Scheduler`	`scheduler()` Answers the `Scheduler` for this `Actor`.
`protected void`	`secure()` Secures this `Actor`.
`protected <T> T`	`selfAs(Class<T> protocol)` Answers this `Actor` as a `T` protocol.
`protected Stage`	`stage()` Answers the `Stage` of this `Actor`.
`protected Stage`	`stageNamed(String name)` Answers the `Stage` of the given name.
`void`	`start()` The default implementation of `start()`, which is a no-op.
`<S> S`	`stateSnapshot()` Answer my `S` typed state snapshot, which is `null` by default.
`<S> void`	`stateSnapshot(S stateSnapshot)` Sets my `S` typed state snapshot, which by default does nothing.
`void`	`stop()` Initiates the process of stopping this `Actor` and all of its children.
`protected void`	`stowMessages(Class<?>... stowageOverrides)` Starts the process of stowing messages for this `Actor`, and registers `stowageOverrides` as the protocol that will trigger dispersal.
`String`	`toString()` Answers the `String` representation of this `Actor`.
`TestState`	`viewTestState()` Answers the `TestState` for this `Actor`.
`void`	`viewTestStateInitialization(TestContext context)` Received from the surrounding `testkit.TestActor` to indicate that it is in use, enabling any special test initialization as needed.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Actor
```
protected Actor()
```
    Initializes the newly created Actor.
- Method Detail
  - address
```
public Address address()
```
    Answers the address of this Actor.
    
    Returns:
    
    Address
  - conclude
```
public void conclude()
```
    Description copied from interface: Stoppable
    
    Concludes the receiver, eventually causing it to receive a stop() message.
    
    Specified by:
    
    conclude in interface Stoppable
    
    See Also:
    
    Stoppable.conclude()
  - deadLetters
```
public DeadLetters deadLetters()
```
    Answers the DeadLetters for this Actor.
    
    Returns:
    
    DeadLetters
  - scheduler
```
public io.vlingo.xoom.common.Scheduler scheduler()
```
    Answers the Scheduler for this Actor.
    
    Returns:
    
    Scheduler
  - stateSnapshot
```
public <S> void stateSnapshot(S stateSnapshot)
```
    Description copied from interface: Relocatable
    
    Sets my S typed state snapshot, which by default does nothing. Override to set a snapshot state.
    
    Specified by:
    
    stateSnapshot in interface Relocatable
    
    Type Parameters:
    
    S - the type of the state snapshot
    
    Parameters:
    
    stateSnapshot - the S typed state snapshot to set
    
    See Also:
    
    Relocatable.stateSnapshot(java.lang.Object)
  - stateSnapshot
```
public <S> S stateSnapshot()
```
    Description copied from interface: Relocatable
    
    Answer my S typed state snapshot, which is null by default. Override to provide a snapshot state.
    
    Specified by:
    
    stateSnapshot in interface Relocatable
    
    Type Parameters:
    
    S - the type of my snapshot state
    
    Returns:
    
    S
    
    See Also:
    
    Relocatable.stateSnapshot()
  - start
```
public void start()
```
    The default implementation of start(), which is a no-op. Override if needed.
    
    Specified by:
    
    start in interface Startable
    
    See Also:
    
    Startable.start()
  - isStopped
```
public boolean isStopped()
```
    Answers whether or not this Actor has been stopped or is in the process or stopping.
    
    Specified by:
    
    isStopped in interface Stoppable
    
    Returns:
    
    boolean
    
    See Also:
    
    Stoppable.isStopped()
  - stop
```
public void stop()
```
    Initiates the process of stopping this Actor and all of its children.
    
    Specified by:
    
    stop in interface Stoppable
    
    See Also:
    
    Stoppable.stop()
  - viewTestStateInitialization
```
public void viewTestStateInitialization(TestContext context)
```
    Received from the surrounding testkit.TestActor to indicate that it is in use, enabling any special test initialization as needed. This is received (1) with a TestContext when the TestActor is first constructed, and (2) with null before each TestMailbox delivery.
    
    Parameters:
    
    context - the TestContext
  - viewTestState
```
public TestState viewTestState()
```
    Answers the TestState for this Actor. Override to provide a snapshot of the current Actor state.
    
    Specified by:
    
    viewTestState in interface TestStateView
    
    Returns:
    
    TestState
  - equals
```
public boolean equals(Object other)
```
    Answers whether or not this Actor is equal to other.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    other - the Object to which this Actor is compared
    
    Returns:
    
    boolean
  - hashCode
```
public int hashCode()
```
    Answers the int hash code of this Actor.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    int
  - toString
```
public String toString()
```
    Answers the String representation of this Actor.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String
  - answerFrom
```
protected <R> io.vlingo.xoom.common.Completes<R> answerFrom(io.vlingo.xoom.common.Completes<R> eventualOutcome)
```
    Answer my internal Completes<R> from completes() after preparing for the eventualOutcome to be set in my completesEventually().
    
    Type Parameters:
    
    R - the type of eventual outcome
    
    Parameters:
    
    eventualOutcome - the Completes<R> the provides an eventual outcome
    
    Returns:
    
    Completes<R>
  - childActorFor
```
protected <T> T childActorFor(Class<T> protocol,
                              Definition definition)
```
    Answers the T protocol for the child Actor to be created by this parent Actor.
    
    Type Parameters:
    
    T - the protocol type
    
    Parameters:
    
    protocol - the Class<T> protocol of the child Actor
    
    definition - the Definition of the child Actor to be created by this parent Actor
    
    Returns:
    
    T
  - childActorFor
```
protected Protocols childActorFor(Class<?>[] protocols,
                                  Definition definition)
```
    Answers the Protocols for the child Actor to be created by this parent Actor.
    
    Parameters:
    
    protocols - the Class<T>[] protocols of the child Actor
    
    definition - the Definition of the child Actor to be created by this parent Actor
    
    Returns:
    
    Protocols
  - completes
```
protected <T> io.vlingo.xoom.common.Completes<T> completes()
```
    Answers the Completes<T> instance for this Actor, or throws IllegalStateException if the behavior of the currently delivered Message does not answer a Completes<T>.
    
    Type Parameters:
    
    T - the protocol type
    
    Returns:
    
    Completes<T>
  - completableFuture
```
protected <T> CompletableFuture<T> completableFuture()
```
    Answers the CompletableFuture<T> instance for this Actor, or throws IllegalStateException if the behavior of the currently delivered Message does not answer a CompletableFuture<T>.
    
    Type Parameters:
    
    T - the protocol type
    
    Returns:
    
    CompletableFuture<T>
  - future
```
protected <T> Future<T> future(Callable<T> callable)
```
    Answers the Future<T> instance for this Actor, or throws IllegalStateException if the behavior of the currently delivered Message does not answer a Future<T>.
    
    Type Parameters:
    
    T - the protocol type
    
    Parameters:
    
    callable - the Callable<T> producing the outcome for the Future<T> to answer
    
    Returns:
    
    Future<T>
  - completesEventually
```
protected CompletesEventually completesEventually()
```
    Answers a CompletesEventually if the behavior of the currently delivered Message does answers a Completes<T>. Otherwise the outcome is undefined.
    
    Returns:
    
    CompletesEventually
  - definition
```
public Definition definition()
```
    Answers the Definition of this Actor.
    
    Returns:
    
    Definition
  - logger
```
protected Logger logger()
```
    Answers the Logger of this Actor.
    
    Returns:
    
    Logger
  - parentAs
```
protected <T> T parentAs(Class<T> protocol)
```
    Answers the parent of this Actor as the T protocol.
    
    Type Parameters:
    
    T - the protocol type
    
    Parameters:
    
    protocol - the Class<T> of the protocol
    
    Returns:
    
    T
  - secure
```
protected void secure()
```
    Secures this Actor. (INTERNAL ONLY)
  - selfAs
```
protected <T> T selfAs(Class<T> protocol)
```
    Answers this Actor as a T protocol. This Actor must implement the Class<T> protocol.
    
    Type Parameters:
    
    T - the protocol type
    
    Parameters:
    
    protocol - the Class<T> protocol
    
    Returns:
    
    T
  - stage
```
protected final Stage stage()
```
    Answers the Stage of this Actor.
    
    Returns:
    
    Stage
  - stageNamed
```
protected Stage stageNamed(String name)
```
    Answers the Stage of the given name.
    
    Parameters:
    
    name - the String name of the Stage to find
    
    Returns:
    
    Stage
  - disperseStowedMessages
```
protected void disperseStowedMessages()
```
    Starts the process of dispersing any messages stowed for this Actor.
  - stowMessages
```
protected void stowMessages(Class<?>... stowageOverrides)
```
    Starts the process of stowing messages for this Actor, and registers stowageOverrides as the protocol that will trigger dispersal.
    
    Parameters:
    
    stowageOverrides - the Class<T> protocol that will trigger dispersal
  - beforeStart
```
protected void beforeStart()
```
    The message delivered before the Actor has fully started. Override to implement.
  - afterStop
```
protected void afterStop()
```
    The message delivered after the Actor has fully stopped. Override to implement.
  - beforeRestart
```
protected void beforeRestart(Throwable reason)
```
    The message delivered before the Actor has been restarted by its supervisor due to an exception. Override to implement.
    
    Parameters:
    
    reason - the Throwable cause of the supervision restart
  - afterRestart
```
protected void afterRestart(Throwable reason)
```
    The message delivered after the Actor has been restarted by its supervisor due to an exception. Override to implement.
    
    Parameters:
    
    reason - the Throwable cause of the supervision restart
  - beforeResume
```
protected void beforeResume(Throwable reason)
```
    The message delivered before the Actor has been resumed by its supervisor due to an exception. Override to implement.
    
    Parameters:
    
    reason - the Throwable cause of the supervision resume

Class Actor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Actor

Method Detail

address

conclude

deadLetters

scheduler

stateSnapshot

stateSnapshot

start

isStopped

stop

viewTestStateInitialization

viewTestState

equals

hashCode

toString

answerFrom

childActorFor

childActorFor

completes

completableFuture

future

completesEventually

definition

logger

parentAs

secure

selfAs

stage

stageNamed

disperseStowedMessages

stowMessages

beforeStart

afterStop

beforeRestart

afterRestart

beforeResume