final class BehaviorBuilder[T] extends AnyRef

Immutable builder used for creating a Behavior by 'chaining' message and signal handlers.

When handling a message or signal, this Behavior will consider all handlers in the order they were added, looking for the first handler for which both the type and the (optional) predicate match.

Akka akka.japi.function lambda types are used throughout to allow handlers to throw checked exceptions (which will fail the actor).

T

the common superclass of all supported messages.

Source
BehaviorBuilder.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BehaviorBuilder
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from BehaviorBuilder[T] toany2stringadd[BehaviorBuilder[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (BehaviorBuilder[T], B)
    Implicit
    This member is added by an implicit conversion from BehaviorBuilder[T] toArrowAssoc[BehaviorBuilder[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def build(): Behavior[T]

    Build a Behavior from the current state of the builder

  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  9. def ensuring(cond: (BehaviorBuilder[T]) => Boolean, msg: => Any): BehaviorBuilder[T]
    Implicit
    This member is added by an implicit conversion from BehaviorBuilder[T] toEnsuring[BehaviorBuilder[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (BehaviorBuilder[T]) => Boolean): BehaviorBuilder[T]
    Implicit
    This member is added by an implicit conversion from BehaviorBuilder[T] toEnsuring[BehaviorBuilder[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): BehaviorBuilder[T]
    Implicit
    This member is added by an implicit conversion from BehaviorBuilder[T] toEnsuring[BehaviorBuilder[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): BehaviorBuilder[T]
    Implicit
    This member is added by an implicit conversion from BehaviorBuilder[T] toEnsuring[BehaviorBuilder[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  21. def onAnyMessage(handler: Function[T, Behavior[T]]): BehaviorBuilder[T]

    Add a new case to the message handling matching any message.

    Add a new case to the message handling matching any message. Subsequent onMessage clauses will never see any messages.

    handler

    action to apply for any message

    returns

    a new behavior builder with the specified handling appended

  22. def onMessage[M <: T](type: Class[M], test: Predicate[M], handler: Function[M, Behavior[T]]): BehaviorBuilder[T]

    Add a new predicated case to the message handling.

    Add a new predicated case to the message handling.

    M

    type of message to match

    type

    type of message to match

    test

    a predicate that will be evaluated on the argument if the type matches

    handler

    action to apply if the type matches and the predicate returns true

    returns

    a new behavior builder with the specified handling appended

  23. def onMessage[M <: T](type: Class[M], handler: Function[M, Behavior[T]]): BehaviorBuilder[T]

    Add a new case to the message handling.

    Add a new case to the message handling.

    M

    type of message to match

    type

    type of message to match

    handler

    action to apply if the type matches

    returns

    a new behavior builder with the specified handling appended

  24. def onMessageEquals(msg: T, handler: Creator[Behavior[T]]): BehaviorBuilder[T]

    Add a new case to the message handling matching equal messages.

    Add a new case to the message handling matching equal messages.

    msg

    the message to compare to

    handler

    action to apply when the message matches

    returns

    a new behavior builder with the specified handling appended

  25. def onMessageUnchecked[M <: T](type: Class[_ <: T], handler: Function[M, Behavior[T]]): BehaviorBuilder[T]

    Add a new case to the message handling without compile time type check.

    Add a new case to the message handling without compile time type check.

    Should normally not be used, but when matching on class with generic type argument it can be useful, e.g. List.class and (List<String> list) -> {...}

    type

    type of message to match

    handler

    action to apply when the type matches

    returns

    a new behavior builder with the specified handling appended

  26. def onSignal[M <: Signal](type: Class[M], test: Predicate[M], handler: Function[M, Behavior[T]]): BehaviorBuilder[T]

    Add a new predicated case to the signal handling.

    Add a new predicated case to the signal handling.

    M

    type of signal to match

    type

    type of signals to match

    test

    a predicate that will be evaluated on the argument if the type matches

    handler

    action to apply if the type matches and the predicate returns true

    returns

    a new behavior builder with the specified handling appended

  27. def onSignal[M <: Signal](type: Class[M], handler: Function[M, Behavior[T]]): BehaviorBuilder[T]

    Add a new case to the signal handling.

    Add a new case to the signal handling.

    M

    type of signal to match

    type

    type of signal to match

    handler

    action to apply if the type matches

    returns

    a new behavior builder with the specified handling appended

  28. def onSignalEquals(signal: Signal, handler: Creator[Behavior[T]]): BehaviorBuilder[T]

    Add a new case to the signal handling matching equal signals.

    Add a new case to the signal handling matching equal signals.

    signal

    the signal to compare to

    handler

    action to apply when the message matches

    returns

    a new behavior builder with the specified handling appended

  29. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  30. def toString(): String
    Definition Classes
    AnyRef → Any
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from BehaviorBuilder[T] toStringFormat[BehaviorBuilder[T]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (BehaviorBuilder[T], B)
    Implicit
    This member is added by an implicit conversion from BehaviorBuilder[T] toArrowAssoc[BehaviorBuilder[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromBehaviorBuilder[T] to any2stringadd[BehaviorBuilder[T]]

Inherited by implicit conversion StringFormat fromBehaviorBuilder[T] to StringFormat[BehaviorBuilder[T]]

Inherited by implicit conversion Ensuring fromBehaviorBuilder[T] to Ensuring[BehaviorBuilder[T]]

Inherited by implicit conversion ArrowAssoc fromBehaviorBuilder[T] to ArrowAssoc[BehaviorBuilder[T]]

Ungrouped