State

case class State[S, D](stateName: S, stateData: D, timeout: Option[FiniteDuration] = None, stopReason: Option[Reason] = None, replies: List[Any] = Nil) extends Product with Serializable

This captures all of the managed state of the akka.actor.FSM: the state name, the state data, possibly custom timeout, stop reason and replies accumulated while processing the last message.

Source: FSM.scala

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Type Hierarchy

Ordering

Alphabetic
By Inheritance

Inherited

State
Serializable
Serializable
Product
Equals
AnyRef
Any

Implicitly

by any2stringadd
by StringFormat
by Ensuring
by ArrowAssoc

Hide All
Show All

Visibility

Public
All

Instance Constructors

new State(stateName: S, stateData: D, timeout: Option[FiniteDuration] = None, stopReason: Option[Reason] = None, replies: List[Any] = Nil)

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
def +(other: String): String

Implicit
This member is added by an implicit conversion from State[S, D] to any2stringadd[State[S, D]] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (State[S, D], B)

Implicit
This member is added by an implicit conversion from State[S, D] to ArrowAssoc[State[S, D]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def copy(stateName: S = stateName, stateData: D = stateData, timeout: Option[FiniteDuration] = timeout, stopReason: Option[Reason] = stopReason, replies: List[Any] = replies): State[S, D]
def ensuring(cond: (State[S, D]) ⇒ Boolean, msg: ⇒ Any): State[S, D]

Implicit
This member is added by an implicit conversion from State[S, D] to Ensuring[State[S, D]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (State[S, D]) ⇒ Boolean): State[S, D]

Implicit
This member is added by an implicit conversion from State[S, D] to Ensuring[State[S, D]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): State[S, D]

Implicit
This member is added by an implicit conversion from State[S, D] to Ensuring[State[S, D]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): State[S, D]

Implicit
This member is added by an implicit conversion from State[S, D] to Ensuring[State[S, D]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def forMax(timeout: Duration): State[S, D]
Modify state transition descriptor to include a state timeout for the next state.
Modify state transition descriptor to include a state timeout for the next state. This timeout overrides any default timeout set for the next state.
Use Duration.Inf to deactivate an existing timeout.
def formatted(fmtstr: String): String

Implicit
This member is added by an implicit conversion from State[S, D] to StringFormat[State[S, D]] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val replies: List[Any]
def replying(replyValue: Any): State[S, D]
Send reply to sender of the current message, if available.
Send reply to sender of the current message, if available.
returns
this state transition descriptor
val stateData: D
val stateName: S
val stopReason: Option[Reason]
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val timeout: Option[FiniteDuration]
def using(nextStateData: D): State[S, D]
Modify state transition descriptor with new state data.
Modify state transition descriptor with new state data. The data will be set when transitioning to the new state.
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def →[B](y: B): (State[S, D], B)

Implicit
This member is added by an implicit conversion from State[S, D] to ArrowAssoc[State[S, D]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Inherited from AnyRef

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Inherited from Any

Value Members

final def asInstanceOf[T0]: T0

Definition Classes
Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any

Inherited by implicit conversion any2stringadd from State[S, D] to any2stringadd[State[S, D]]

Value Members

def +(other: String): String

Implicit
This member is added by an implicit conversion from State[S, D] to any2stringadd[State[S, D]] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd

Inherited by implicit conversion StringFormat from State[S, D] to StringFormat[State[S, D]]

Value Members

def formatted(fmtstr: String): String

Implicit
This member is added by an implicit conversion from State[S, D] to StringFormat[State[S, D]] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()

Inherited by implicit conversion Ensuring from State[S, D] to Ensuring[State[S, D]]

Value Members

def ensuring(cond: (State[S, D]) ⇒ Boolean, msg: ⇒ Any): State[S, D]

Implicit
This member is added by an implicit conversion from State[S, D] to Ensuring[State[S, D]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (State[S, D]) ⇒ Boolean): State[S, D]

Implicit
This member is added by an implicit conversion from State[S, D] to Ensuring[State[S, D]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): State[S, D]

Implicit
This member is added by an implicit conversion from State[S, D] to Ensuring[State[S, D]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): State[S, D]

Implicit
This member is added by an implicit conversion from State[S, D] to Ensuring[State[S, D]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring

Inherited by implicit conversion ArrowAssoc from State[S, D] to ArrowAssoc[State[S, D]]

Value Members

def ->[B](y: B): (State[S, D], B)

Implicit
This member is added by an implicit conversion from State[S, D] to ArrowAssoc[State[S, D]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
def →[B](y: B): (State[S, D], B)

Implicit
This member is added by an implicit conversion from State[S, D] to ArrowAssoc[State[S, D]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Ungrouped

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
def +(other: String): String

Implicit
This member is added by an implicit conversion from State[S, D] to any2stringadd[State[S, D]] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (State[S, D], B)

Implicit
This member is added by an implicit conversion from State[S, D] to ArrowAssoc[State[S, D]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def copy(stateName: S = stateName, stateData: D = stateData, timeout: Option[FiniteDuration] = timeout, stopReason: Option[Reason] = stopReason, replies: List[Any] = replies): State[S, D]
def ensuring(cond: (State[S, D]) ⇒ Boolean, msg: ⇒ Any): State[S, D]

Implicit
This member is added by an implicit conversion from State[S, D] to Ensuring[State[S, D]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (State[S, D]) ⇒ Boolean): State[S, D]

Implicit
This member is added by an implicit conversion from State[S, D] to Ensuring[State[S, D]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): State[S, D]

Implicit
This member is added by an implicit conversion from State[S, D] to Ensuring[State[S, D]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): State[S, D]

Implicit
This member is added by an implicit conversion from State[S, D] to Ensuring[State[S, D]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def forMax(timeout: Duration): State[S, D]
Modify state transition descriptor to include a state timeout for the next state.
Modify state transition descriptor to include a state timeout for the next state. This timeout overrides any default timeout set for the next state.
Use Duration.Inf to deactivate an existing timeout.
def formatted(fmtstr: String): String

Implicit
This member is added by an implicit conversion from State[S, D] to StringFormat[State[S, D]] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val replies: List[Any]
def replying(replyValue: Any): State[S, D]
Send reply to sender of the current message, if available.
Send reply to sender of the current message, if available.
returns
this state transition descriptor
val stateData: D
val stateName: S
val stopReason: Option[Reason]
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val timeout: Option[FiniteDuration]
def using(nextStateData: D): State[S, D]
Modify state transition descriptor with new state data.
Modify state transition descriptor with new state data. The data will be set when transitioning to the new state.
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def →[B](y: B): (State[S, D], B)

Implicit
This member is added by an implicit conversion from State[S, D] to ArrowAssoc[State[S, D]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Packages

State 

case class State[S, D](stateName: S, stateData: D, timeout: Option[FiniteDuration] = None, stopReason: Option[Reason] = None, replies: List[Any] = Nil) extends Product with Serializable

Instance Constructors

Value Members

Inherited from AnyRef

Value Members

Inherited from Any

Value Members

Inherited by implicit conversion any2stringadd from State[S, D] to any2stringadd[State[S, D]]

Value Members

Inherited by implicit conversion StringFormat from State[S, D] to StringFormat[State[S, D]]

Value Members

Inherited by implicit conversion Ensuring from State[S, D] to Ensuring[State[S, D]]

Value Members

Inherited by implicit conversion ArrowAssoc from State[S, D] to ArrowAssoc[State[S, D]]

Value Members

Ungrouped

State