io.spine.server.route

Class DefaultCommandRoute<I>

java.lang.Object

io.spine.server.route.DefaultCommandRoute<I>

Type Parameters:

I - the type of target entity IDs

All Implemented Interfaces:

CommandRoute<I,io.spine.base.CommandMessage>, Route<io.spine.base.CommandMessage,io.spine.core.CommandContext,I>, Unicast<I,io.spine.base.CommandMessage,io.spine.core.CommandContext>, java.io.Serializable, java.util.function.BiFunction<io.spine.base.CommandMessage,io.spine.core.CommandContext,I>

public final class DefaultCommandRoute<I>
extends java.lang.Object
implements CommandRoute<I,io.spine.base.CommandMessage>

Obtains an ID of a command target entity from the first field of the command message.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
I	apply(io.spine.base.CommandMessage message, io.spine.core.CommandContext ignored) Obtains entity ID(s) from the passed message and its context.
static boolean	exists(io.spine.base.CommandMessage commandMessage) Verifies of the passed command message potentially has a field with an entity ID.
static <I> DefaultCommandRoute<I>	newInstance(java.lang.Class<I> idClass) Creates a new instance.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.BiFunction

andThen

Method Detail

newInstance

public static <I> DefaultCommandRoute<I> newInstance(java.lang.Class<I> idClass)

Creates a new instance.

Parameters:

idClass - the class of identifiers used for the routing

apply

public I apply(io.spine.base.CommandMessage message,
               io.spine.core.CommandContext ignored)
        throws io.spine.protobuf.MessageFieldException

Description copied from interface: Route

Obtains entity ID(s) from the passed message and its context.

Specified by:

apply in interface Route<io.spine.base.CommandMessage,io.spine.core.CommandContext,I>

Specified by:

apply in interface java.util.function.BiFunction<io.spine.base.CommandMessage,io.spine.core.CommandContext,I>

Parameters:

message - the event or a command message

ignored - the context of the message

Returns:

the set of entity identifiers

Throws:

io.spine.protobuf.MessageFieldException

exists

public static boolean exists(io.spine.base.CommandMessage commandMessage)

Verifies of the passed command message potentially has a field with an entity ID.