Packages

c

akka.japi.pf

ReceiveBuilder

class ReceiveBuilder extends AnyRef

Used for building a partial function for AbstractActor.createReceive().

There is both a match on type only, and a match on type and predicate.

Inside an actor you can use it like this:

Example:

@Override
public Receive createReceive() {
  return receiveBuilder()
    .match(Double.class, d -> {
      getSender().tell(d.isNaN() ? 0 : d, self());
    })
    .match(Integer.class, i -> {
      getSender().tell(i * 10, self());
    })
    .match(String.class, s -> s.startsWith("foo"), s -> {
      getSender().tell(s.toUpperCase(), self());
    })
    .build()
  );
}

Source
ReceiveBuilder.java
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ReceiveBuilder
  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

Instance Constructors

  1. new ReceiveBuilder()

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 ReceiveBuilder toany2stringadd[ReceiveBuilder] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ReceiveBuilder, B)
    Implicit
    This member is added by an implicit conversion from ReceiveBuilder toArrowAssoc[ReceiveBuilder] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def addStatement(statement: PartialFunction[AnyRef, BoxedUnit]): Unit
    Attributes
    protected[pf]
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def build(): Receive

    Build a scala.PartialFunction from this builder.

    Build a scala.PartialFunction from this builder. After this call the builder will be reset.

    returns

    a PartialFunction for this builder.

  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  10. def ensuring(cond: (ReceiveBuilder) => Boolean, msg: => Any): ReceiveBuilder
    Implicit
    This member is added by an implicit conversion from ReceiveBuilder toEnsuring[ReceiveBuilder] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (ReceiveBuilder) => Boolean): ReceiveBuilder
    Implicit
    This member is added by an implicit conversion from ReceiveBuilder toEnsuring[ReceiveBuilder] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: => Any): ReceiveBuilder
    Implicit
    This member is added by an implicit conversion from ReceiveBuilder toEnsuring[ReceiveBuilder] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): ReceiveBuilder
    Implicit
    This member is added by an implicit conversion from ReceiveBuilder toEnsuring[ReceiveBuilder] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  16. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ReceiveBuilder toStringFormat[ReceiveBuilder] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. def match[P](type: Class[P], externalPredicate: BooleanSupplier, apply: UnitApply[P]): ReceiveBuilder

    Add a new case statement to this builder.

    Add a new case statement to this builder.

    type

    a type to match the argument against

    externalPredicate

    a external predicate that will be evaluated if the type matches

    apply

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

    returns

    a builder with the case statement added

  21. def match[P](type: Class[P], predicate: TypedPredicate[P], apply: UnitApply[P]): ReceiveBuilder

    Add a new case statement to this builder.

    Add a new case statement to this builder.

    type

    a type to match the argument against

    predicate

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

    apply

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

    returns

    a builder with the case statement added

  22. def match[P](type: Class[P], apply: UnitApply[P]): ReceiveBuilder

    Add a new case statement to this builder.

    Add a new case statement to this builder.

    type

    a type to match the argument against

    apply

    an action to apply to the argument if the type matches

    returns

    a builder with the case statement added

  23. def matchAny(externalPredicate: BooleanSupplier, apply: UnitApply[AnyRef]): ReceiveBuilder

    Add a new case statement to this builder, that pass the test of the predicate.

    Add a new case statement to this builder, that pass the test of the predicate.

    externalPredicate

    an external predicate that will always be evaluated.

    apply

    an action to apply to the argument

    returns

    a builder with the case statement added

  24. def matchAny(apply: UnitApply[AnyRef]): ReceiveBuilder

    Add a new case statement to this builder, that matches any argument.

    Add a new case statement to this builder, that matches any argument.

    apply

    an action to apply to the argument

    returns

    a builder with the case statement added

  25. def matchEquals[P](object: P, externalPredicate: BooleanSupplier, apply: UnitApply[P]): ReceiveBuilder

    Add a new case statement to this builder.

    Add a new case statement to this builder.

    object

    the object to compare equals with

    externalPredicate

    an external predicate that will be evaluated if the object compares equal

    apply

    an action to apply to the argument if the object compares equal

    returns

    a builder with the case statement added

    Annotations
    @SuppressWarnings()
  26. def matchEquals[P](object: P, predicate: TypedPredicate[P], apply: UnitApply[P]): ReceiveBuilder

    Add a new case statement to this builder.

    Add a new case statement to this builder.

    object

    the object to compare equals with

    predicate

    a predicate that will be evaluated on the argument if the object compares equal

    apply

    an action to apply to the argument if the object compares equal

    returns

    a builder with the case statement added

  27. def matchEquals[P](object: P, apply: UnitApply[P]): ReceiveBuilder

    Add a new case statement to this builder.

    Add a new case statement to this builder.

    object

    the object to compare equals with

    apply

    an action to apply to the argument if the object compares equal

    returns

    a builder with the case statement added

  28. def matchUnchecked[P](type: Class[_ <: AnyRef], externalPredicate: BooleanSupplier, apply: UnitApply[P]): ReceiveBuilder

    Add a new case statement to this builder without compile time type check.

    Add a new case statement to this builder 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

    a type to match the argument against

    externalPredicate

    an external predicate that will be evaluated if the type matches

    apply

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

    returns

    a builder with the case statement added

    Annotations
    @SuppressWarnings()
  29. def matchUnchecked[P](type: Class[_ <: AnyRef], predicate: TypedPredicate[_ <: AnyRef], apply: UnitApply[P]): ReceiveBuilder

    Add a new case statement to this builder without compile time type check.

    Add a new case statement to this builder 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

    a type to match the argument against

    predicate

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

    apply

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

    returns

    a builder with the case statement added

    Annotations
    @SuppressWarnings()
  30. def matchUnchecked(type: Class[_ <: AnyRef], apply: UnitApply[_ <: AnyRef]): ReceiveBuilder

    Add a new case statement to this builder without compile time type check.

    Add a new case statement to this builder 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

    a type to match the argument against

    apply

    an action to apply to the argument if the type matches

    returns

    a builder with the case statement added

    Annotations
    @SuppressWarnings()
  31. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  33. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  34. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  35. def toString(): String
    Definition Classes
    AnyRef → Any
  36. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  37. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  38. 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
  2. def [B](y: B): (ReceiveBuilder, B)
    Implicit
    This member is added by an implicit conversion from ReceiveBuilder toArrowAssoc[ReceiveBuilder] 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 fromReceiveBuilder to any2stringadd[ReceiveBuilder]

Inherited by implicit conversion StringFormat fromReceiveBuilder to StringFormat[ReceiveBuilder]

Inherited by implicit conversion Ensuring fromReceiveBuilder to Ensuring[ReceiveBuilder]

Inherited by implicit conversion ArrowAssoc fromReceiveBuilder to ArrowAssoc[ReceiveBuilder]

Ungrouped