io.spine.server.commandbus

Class CommandException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

io.spine.server.commandbus.CommandException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

InvalidCommandException, UnsupportedCommandException

public abstract class CommandException
extends java.lang.RuntimeException

Abstract base for exceptions related to commands.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTR_COMMAND_TYPE_NAME The name of the attribute of the command type reported in an error.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CommandException(java.lang.String messageText, io.spine.core.Command command, io.spine.base.Error error) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
io.spine.base.Error	asError()
java.lang.Throwable	asThrowable()
static java.util.Map<java.lang.String,com.google.protobuf.Value>	commandTypeAttribute(com.google.protobuf.Message commandMessage) Returns a map with a command type attribute.
protected static io.spine.base.Error	createError(java.lang.String format, io.spine.core.Command command, io.spine.core.CommandValidationError errorCode)
io.spine.core.Command	getCommand() Returns a related command.
protected static java.lang.String	messageFormat(java.lang.String format, io.spine.core.Command command) Builds a formatted string for the passed format and a command.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Detail

ATTR_COMMAND_TYPE_NAME

public static final java.lang.String ATTR_COMMAND_TYPE_NAME

The name of the attribute of the command type reported in an error.

See Also:

CommandException.commandTypeAttribute(Message), Error, Constant Field Values

Constructor Detail

CommandException

protected CommandException(java.lang.String messageText,
                           io.spine.core.Command command,
                           io.spine.base.Error error)

Creates a new instance.

Parameters:

messageText - an error message text

command - a related command

error - an error occurred

Method Detail

commandTypeAttribute

public static java.util.Map<java.lang.String,com.google.protobuf.Value> commandTypeAttribute(com.google.protobuf.Message commandMessage)

Returns a map with a command type attribute.

Parameters:

commandMessage - a command message to get the type from

createError

protected static io.spine.base.Error createError(java.lang.String format,
                                                 io.spine.core.Command command,
                                                 io.spine.core.CommandValidationError errorCode)

getCommand

public io.spine.core.Command getCommand()

Returns a related command.

asError

public io.spine.base.Error asError()

asThrowable

public java.lang.Throwable asThrowable()

messageFormat

protected static java.lang.String messageFormat(java.lang.String format,
                                                io.spine.core.Command command)

Builds a formatted string for the passed format and a command.

The first parameter of the formatted string is a ClassName of the command message.

The second parameter is a TypeName of the command message.