akka.persistence.multidc.javadsl

Class CommandHandlerBuilder<Command,Event,State>

java.lang.Object

akka.persistence.multidc.javadsl.CommandHandlerBuilder<Command,Event,State>

All Implemented Interfaces:

SignalHandlerBuilder<Command,Event,State>

public final class CommandHandlerBuilder<Command,Event,State>
extends java.lang.Object
implements SignalHandlerBuilder<Command,Event,State>

Mutable builder for Java CommandHandlers. Handling of commands are added with the match methods and finally a CommandHandler is created with build().

Match statements are appended and evaluated in order, the first one to match is used. If no match is found when evaluating the built CommandHandler for a given command a MatchError is thrown.

Instances should not be created by user code but instead accessed through ReplicatedEntity.commandHandlerBuilder(java.lang.Class<Command>).

Constructor Summary

Constructors

Constructor and Description
CommandHandlerBuilder(java.lang.Class<Command> rootCommandClass)

Method Summary

Modifier and Type	Method and Description
CommandHandler<Command,Event,State>	build() Build a command handler from the appended cases.
CommandHandler<Command,Event,State>	matchAny(CommandToEffect<Command,Event,State> commandToEffect) Match any command
<C extends Command> CommandHandlerBuilder<Command,Event,State>	matchCommand(java.lang.Class<C> commandClass, CommandToEffect<C,Event,State> commandToEffect) Match any command which is an instance or a subtype of commandClass
<C extends Command> CommandHandlerBuilder<Command,Event,State>	matchCommand(java.lang.Class<C> commandClass, akka.japi.pf.FI.TypedPredicate<C> predicate, CommandToEffect<C,Event,State> commandToEffect) Match any command which is an instance or a subtype of commandClass and which the given predicate returns true for.
CommandHandlerBuilder<Command,Event,State>	matchCommand(akka.japi.pf.FI.TypedPredicate<Command> predicate, CommandToEffect<Command,Event,State> commandToEffect) Match any command which the given predicate returns true for
<C extends Command> CommandHandlerBuilder<Command,Event,State>	matchExactCommand(C exactly, CommandToEffect<C,Event,State> commandToEffect) Match any command which equals exactly

Methods inherited from class java.lang.Object

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

Methods inherited from interface akka.persistence.multidc.javadsl.SignalHandlerBuilder

buildSignalHandlers, onReceiveTimeout, onTerminated, onTimer, signalHandlers_$eq, signalHandlers

Constructor Detail

CommandHandlerBuilder

public CommandHandlerBuilder(java.lang.Class<Command> rootCommandClass)

Method Detail

build

public CommandHandler<Command,Event,State> build()

Build a command handler from the appended cases. The returned handler will throw a MatchError if applied to a command that has no defined match.

The builder is reset to empty after build has been called.

Specified by:

build in interface SignalHandlerBuilder<Command,Event,State>

Returns:

(undocumented)

matchAny

public CommandHandler<Command,Event,State> matchAny(CommandToEffect<Command,Event,State> commandToEffect)

Match any command

Builds and returns the handler since this will not let through any command to subsequent match statements

Parameters:

commandToEffect - (undocumented)

Returns:

(undocumented)

matchCommand

public CommandHandlerBuilder<Command,Event,State> matchCommand(akka.japi.pf.FI.TypedPredicate<Command> predicate,
                                                               CommandToEffect<Command,Event,State> commandToEffect)

Match any command which the given predicate returns true for

Parameters:

predicate - (undocumented)

commandToEffect - (undocumented)

Returns:

(undocumented)

matchCommand

public <C extends Command> CommandHandlerBuilder<Command,Event,State> matchCommand(java.lang.Class<C> commandClass,
                                                                                   CommandToEffect<C,Event,State> commandToEffect)

Match any command which is an instance or a subtype of commandClass

Throws java.lang.IllegalArgumentException if commandClass is not a subtype of the root Command this builder was created with

Parameters:

commandClass - (undocumented)

commandToEffect - (undocumented)

Returns:

(undocumented)

matchCommand

public <C extends Command> CommandHandlerBuilder<Command,Event,State> matchCommand(java.lang.Class<C> commandClass,
                                                                                   akka.japi.pf.FI.TypedPredicate<C> predicate,
                                                                                   CommandToEffect<C,Event,State> commandToEffect)

Match any command which is an instance or a subtype of commandClass and which the given predicate returns true for.

Throws java.lang.IllegalArgumentException if commandClass is not a subtype of the root Command this builder was created with

Parameters:

commandClass - (undocumented)

predicate - (undocumented)

commandToEffect - (undocumented)

Returns:

(undocumented)

matchExactCommand

public <C extends Command> CommandHandlerBuilder<Command,Event,State> matchExactCommand(C exactly,
                                                                                        CommandToEffect<C,Event,State> commandToEffect)

Match any command which equals exactly

Throws java.lang.IllegalArgumentException if exactly is not a subtype of the root Command this builder was created with

Parameters:

exactly - (undocumented)

commandToEffect - (undocumented)

Returns:

(undocumented)