Package org.apache.pekko.japi.pf

Class FSMStopBuilder<S,D>

java.lang.Object

org.apache.pekko.japi.pf.FSMStopBuilder<S,D>

Type Parameters:

S - the state type

D - the data type

public class FSMStopBuilder<S,D>
extends Object

Builder used to create a partial function for FSM.onTermination(scala.PartialFunction<org.apache.pekko.actor.FSM.StopEvent<S, D>, scala.runtime.BoxedUnit>).

Constructor Summary

Constructors

Constructor	Description
FSMStopBuilder()

Method Summary

Modifier and Type	Method	Description
scala.PartialFunction<FSM.StopEvent<S,D>,scala.runtime.BoxedUnit>	build()	Build a PartialFunction from this builder.
<P extends FSM.Reason> FSMStopBuilder<S,D>	stop(Class<P> reasonType, Predicate<P> predicate, Procedure3<P,S,D> apply)	Add a case statement that matches on a reason type and a predicate.
<P extends FSM.Reason> FSMStopBuilder<S,D>	stop(Class<P> reasonType, Procedure3<P,S,D> apply)	Add a case statement that matches on a reason type.
FSMStopBuilder<S,D>	stop(FSM.Reason reason, Procedure2<S,D> apply)	Add a case statement that matches on an FSM.Reason.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FSMStopBuilder

public FSMStopBuilder()

Method Details

stop

public FSMStopBuilder<S,D> stop(FSM.Reason reason,
 Procedure2<S,D> apply)

Add a case statement that matches on an FSM.Reason.

Parameters:

reason - the reason for the termination

apply - an action to apply to the event and state data if there is a match

Returns:

the builder with the case statement added

stop

public <P extends FSM.Reason> FSMStopBuilder<S,D> stop(Class<P> reasonType,
 Procedure3<P,S,D> apply)

Add a case statement that matches on a reason type.

Type Parameters:

P - the reason type to match on

Parameters:

reasonType - the reason type to match on

apply - an action to apply to the reason, event and state data if there is a match

Returns:

the builder with the case statement added

stop

public <P extends FSM.Reason> FSMStopBuilder<S,D> stop(Class<P> reasonType,
 Predicate<P> predicate,
 Procedure3<P,S,D> apply)

Add a case statement that matches on a reason type and a predicate.

Type Parameters:

P - the reason type to match on

Parameters:

reasonType - the reason type to match on

apply - an action to apply to the reason, event and state data if there is a match

predicate - a predicate that will be evaluated on the reason if the type matches

Returns:

the builder with the case statement added

build

public scala.PartialFunction<FSM.StopEvent<S,D>,scala.runtime.BoxedUnit> build()

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

Returns:

a PartialFunction for this builder.