io.spine.client

Class CommandFactory

java.lang.Object

io.spine.client.CommandFactory

public final class CommandFactory
extends java.lang.Object

A factory of Command instances.

Uses the given ActorRequestFactory as a source of command meta information such as the actor, the tenant, and others.

The command messages passed to the factory are validated according to their Proto definitions. If a given message is invalid, a ValidationException is thrown.

See Also:

ActorRequestFactory.command()

Method Summary

Modifier and Type	Method and Description
io.spine.core.Command	create(io.spine.base.CommandMessage message) Creates a new Command with the given message.
io.spine.core.Command	create(io.spine.base.CommandMessage message, int targetVersion) Creates a new Command with the passed message and target entity version.

Methods inherited from class java.lang.Object

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

Method Detail

create

public io.spine.core.Command create(io.spine.base.CommandMessage message)
                             throws io.spine.validate.ValidationException

Creates a new Command with the given message.

Parameters:

message - the command message

Returns:

new command instance

Throws:

io.spine.validate.ValidationException - if the passed message does not satisfy the constraints, set for it in its Protobuf definition

create

public io.spine.core.Command create(io.spine.base.CommandMessage message,
                                    int targetVersion)
                             throws io.spine.validate.ValidationException

Creates a new Command with the passed message and target entity version.

The targetVersion parameter defines the version of the entity which handles the resulting command. Note that the framework performs no validation of the target version before a command is handled. Instead users themselves can perform validation.

Parameters:

message - the command message

targetVersion - the version of the entity for which this command is intended

Returns:

new command instance

Throws:

io.spine.validate.ValidationException - if the passed message does not satisfy the constraints set for it in its Protobuf definition