Package org.axonframework.commandhandling

Class GenericCommandResultMessage<R>

java.lang.Object

org.axonframework.messaging.MessageDecorator<R>

org.axonframework.messaging.GenericResultMessage<R>

org.axonframework.commandhandling.GenericCommandResultMessage<R>

Type Parameters:

R - The type of the payload contained in this Message

All Implemented Interfaces:

Serializable, CommandResultMessage<R>, Message<R>, ResultMessage<R>

public class GenericCommandResultMessage<R>
extends GenericResultMessage<R>
implements CommandResultMessage<R>

Generic implementation of CommandResultMessage.

Since:

4.0

Author:

Milan Savic

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
GenericCommandResultMessage(Throwable exception)	Creates a Command Result Message with the given exception.
GenericCommandResultMessage(Throwable exception, Map<String,?> metaData)	Creates a Command Result Message with the given exception and metaData.
GenericCommandResultMessage(Message<R> delegate)	Creates a new Command Result Message with given delegate message.
GenericCommandResultMessage(Message<R> delegate, Throwable exception)	Creates a Command Result Message with given delegate message and exception.
GenericCommandResultMessage(R commandResult)	Creates a Command Result Message with the given commandResult as the payload.
GenericCommandResultMessage(R commandResult, Map<String,?> metaData)	Creates a Command Result Message with the given commandResult as the payload and metaData as the meta data.

Method Summary

Modifier and Type	Method	Description
GenericCommandResultMessage<R>	andMetaData(Map<String,?> metaData)	Returns a copy of this Message with it MetaData merged with the given metaData.
static <T> CommandResultMessage<T>	asCommandResultMessage(Object commandResult)	Returns the given commandResult as a CommandResultMessage instance.
static <T> CommandResultMessage<T>	asCommandResultMessage(Throwable exception)	Creates a Command Result Message with the given exception result.
protected String	describeType()	Describe the type of message, used in MessageDecorator.toString().
GenericCommandResultMessage<R>	withMetaData(Map<String,?> metaData)	Returns a copy of this Message with the given metaData.

Methods inherited from class org.axonframework.messaging.GenericResultMessage

asResultMessage, asResultMessage, describeTo, getPayload, isExceptional, optionalExceptionResult, serializePayload

Methods inherited from class org.axonframework.messaging.MessageDecorator

getDelegate, getIdentifier, getMetaData, getPayloadType, serializeMetaData, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.axonframework.messaging.Message

getIdentifier, getMetaData, getPayload, getPayloadType, serializeMetaData

Methods inherited from interface org.axonframework.messaging.ResultMessage

exceptionDetails, exceptionResult, isExceptional, optionalExceptionResult, serializeExceptionResult, serializePayload

Constructor Details

GenericCommandResultMessage

public GenericCommandResultMessage(@Nullable
 R commandResult)

Creates a Command Result Message with the given commandResult as the payload.

Parameters:

commandResult - the payload for the Message

GenericCommandResultMessage

public GenericCommandResultMessage(@Nonnull
 Throwable exception)

Creates a Command Result Message with the given exception.

Parameters:

exception - the Exception describing the cause of an error

GenericCommandResultMessage

public GenericCommandResultMessage(@Nonnull
 R commandResult,
 @Nonnull
 Map<String,?> metaData)

Creates a Command Result Message with the given commandResult as the payload and metaData as the meta data.

Parameters:

commandResult - the payload for the Message

metaData - the meta data for the Message

GenericCommandResultMessage

public GenericCommandResultMessage(@Nonnull
 Throwable exception,
 @Nonnull
 Map<String,?> metaData)

Creates a Command Result Message with the given exception and metaData.

Parameters:

exception - the Exception describing the cause of an error

metaData - the meta data for the Message

GenericCommandResultMessage

public GenericCommandResultMessage(@Nonnull
 Message<R> delegate)

Creates a new Command Result Message with given delegate message.

Parameters:

delegate - the message delegate

GenericCommandResultMessage

public GenericCommandResultMessage(@Nonnull
 Message<R> delegate,
 @Nullable
 Throwable exception)

Creates a Command Result Message with given delegate message and exception.

Parameters:

delegate - the Message delegate

exception - the Exception describing the cause of an error

Method Details

asCommandResultMessage

public static <T> CommandResultMessage<T> asCommandResultMessage(@Nonnull
 Object commandResult)

Returns the given commandResult as a CommandResultMessage instance. If commandResult already implements CommandResultMessage, it is returned as-is. If commandResult implements Message, payload and meta data will be used to construct new GenericCommandResultMessage. Otherwise, the given commandResult is wrapped into a GenericCommandResultMessage as its payload.

Type Parameters:

T - The type of the payload contained in returned Message

Parameters:

commandResult - the command result to be wrapped as CommandResultMessage

Returns:

a Message containing given commandResult as payload, or commandResult if already implements CommandResultMessage

asCommandResultMessage

public static <T> CommandResultMessage<T> asCommandResultMessage(@Nonnull
 Throwable exception)

Creates a Command Result Message with the given exception result.

Type Parameters:

T - the type of payload

Parameters:

exception - the Exception describing the cause of an error

Returns:

a message containing exception result

withMetaData

public GenericCommandResultMessage<R> withMetaData(@Nonnull
 Map<String,?> metaData)

Description copied from interface: Message

Returns a copy of this Message with the given metaData. The payload remains unchanged.

While the implementation returned may be different than the implementation of this, implementations must take special care in returning the same type of Message (e.g. EventMessage, DomainEventMessage) to prevent errors further downstream.

Specified by:

withMetaData in interface CommandResultMessage<R>

Specified by:

withMetaData in interface Message<R>

Specified by:

withMetaData in interface ResultMessage<R>

Overrides:

withMetaData in class GenericResultMessage<R>

Parameters:

metaData - The new MetaData for the Message

Returns:

a copy of this message with the given MetaData

andMetaData

public GenericCommandResultMessage<R> andMetaData(@Nonnull
 Map<String,?> metaData)

Description copied from interface: Message

Returns a copy of this Message with it MetaData merged with the given metaData. The payload remains unchanged.

Specified by:

andMetaData in interface CommandResultMessage<R>

Specified by:

andMetaData in interface Message<R>

Specified by:

andMetaData in interface ResultMessage<R>

Overrides:

andMetaData in class GenericResultMessage<R>

Parameters:

metaData - The MetaData to merge with

Returns:

a copy of this message with the given MetaData

describeType

protected String describeType()

Description copied from class: MessageDecorator

Describe the type of message, used in MessageDecorator.toString().

Defaults to the simple class name of the actual instance.

Overrides:

describeType in class GenericResultMessage<R>

Returns:

the type of message