Class BehaviorBuilder<T>

  • Type Parameters:
    T - the common superclass of all supported messages.

    public final class BehaviorBuilder<T>
    extends java.lang.Object
    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.

    • Method Detail

      • create

        public static <T> BehaviorBuilder<T> create()
        Returns:
        new empty immutable behavior builder.
      • build

        public Behavior<T> build()
        Build a Behavior from the current state of the builder
        Returns:
        (undocumented)
      • onMessage

        public <M extends TBehaviorBuilder<T> onMessage​(java.lang.Class<M> type,
                                                          Function2<ActorContext<T>,​M,​Behavior<T>> handler)
        Add a new case to the message handling.

        Parameters:
        type - type of message to match
        handler - action to apply if the type matches
        Returns:
        a new behavior builder with the specified handling appended
      • onMessage

        public <M extends TBehaviorBuilder<T> onMessage​(java.lang.Class<M> type,
                                                          Predicate<M> test,
                                                          Function2<ActorContext<T>,​M,​Behavior<T>> handler)
        Add a new predicated case to the message handling.

        Parameters:
        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
      • onMessageUnchecked

        public <M extends TBehaviorBuilder<T> onMessageUnchecked​(java.lang.Class<? extends T> type,
                                                                   Function2<ActorContext<T>,​M,​Behavior<T>> handler)
        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&lt;String&gt; list) -> {...}

        Parameters:
        type - type of message to match
        handler - action to apply when the type matches
        Returns:
        a new behavior builder with the specified handling appended
      • onMessageEquals

        public BehaviorBuilder<T> onMessageEquals​(T msg,
                                                  Function<ActorContext<T>,​Behavior<T>> handler)
        Add a new case to the message handling matching equal messages.

        Parameters:
        msg - the message to compare to
        handler - action to apply when the message matches
        Returns:
        a new behavior builder with the specified handling appended
      • onAnyMessage

        public BehaviorBuilder<T> onAnyMessage​(Function2<ActorContext<T>,​T,​Behavior<T>> handler)
        Add a new case to the message handling matching any message. Subsequent onMessage clauses will never see any messages.

        Parameters:
        handler - action to apply for any message
        Returns:
        a new behavior builder with the specified handling appended
      • onSignal

        public <M extends SignalBehaviorBuilder<T> onSignal​(java.lang.Class<M> type,
                                                              Function2<ActorContext<T>,​M,​Behavior<T>> handler)
        Add a new case to the signal handling.

        Parameters:
        type - type of signal to match
        handler - action to apply if the type matches
        Returns:
        a new behavior builder with the specified handling appended
      • onSignal

        public <M extends SignalBehaviorBuilder<T> onSignal​(java.lang.Class<M> type,
                                                              Predicate<M> test,
                                                              Function2<ActorContext<T>,​M,​Behavior<T>> handler)
        Add a new predicated case to the signal handling.

        Parameters:
        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
      • onSignalEquals

        public BehaviorBuilder<T> onSignalEquals​(Signal signal,
                                                 scala.Function1<ActorContext<T>,​Behavior<T>> handler)
        Add a new case to the signal handling matching equal signals.

        Parameters:
        signal - the signal to compare to
        handler - action to apply when the message matches
        Returns:
        a new behavior builder with the specified handling appended