Package org.axonframework.messaging.commandhandling

Class GenericCommandResultMessage

java.lang.Object

org.axonframework.messaging.core.MessageDecorator

org.axonframework.messaging.core.GenericResultMessage

org.axonframework.messaging.commandhandling.GenericCommandResultMessage

All Implemented Interfaces:

CommandResultMessage, Message, ResultMessage

public class GenericCommandResultMessage
extends GenericResultMessage
implements CommandResultMessage

Generic implementation of the CommandResultMessage interface.

Since:

4.0.0

Author:

Milan Savic, Steven van Beelen

Field Summary

Fields inherited from interface org.axonframework.messaging.core.Message

RESOURCE_KEY

Constructor Summary

Constructors

Constructor	Description
GenericCommandResultMessage(Message delegate)	Constructs a GenericCommandResultMessage for the given delegate, intended to reconstruct another CommandResultMessage.
GenericCommandResultMessage(MessageType type, Object commandResult)	Constructs a GenericResultMessage for the given type and commandResult.
GenericCommandResultMessage(MessageType type, Object commandResult, Map<String,String> metadata)	Constructs a GenericCommandResultMessage for the given type, commandResult, and metadata.
GenericCommandResultMessage(MessageType type, Throwable exception)	Deprecated.
GenericCommandResultMessage(MessageType type, Throwable exception, Map<String,String> metadata)	Deprecated.

Method Summary

Modifier and Type	Method	Description
CommandResultMessage	andMetadata(Map<String,String> metadata)	Returns a copy of this Message (implementation) with its metadata merged with the given metadata.
protected String	describeType()	Describe the type of message, used in MessageDecorator.toString().
CommandResultMessage	withConvertedPayload(Type type, Converter converter)	Returns a new Message implementation with its Message.payload() converted to the given type by the given converter.
CommandResultMessage	withMetadata(Map<String,String> metadata)	Returns a copy of this Message (implementation) with the given metadata.

Methods inherited from class org.axonframework.messaging.core.GenericResultMessage

asResultMessage

Methods inherited from class org.axonframework.messaging.core.MessageDecorator

delegate, describeTo, identifier, metadata, payload, payloadAs, payloadType, toString, type

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.axonframework.messaging.commandhandling.CommandResultMessage

withConvertedPayload, withConvertedPayload

Methods inherited from interface org.axonframework.messaging.core.Message

identifier, metadata, payload, payloadAs, payloadAs, payloadAs, payloadAs, payloadAs, payloadType, type

Constructor Details

GenericCommandResultMessage

public GenericCommandResultMessage(@Nonnull
 MessageType type,
 @Nullable
 Object commandResult)

Constructs a GenericResultMessage for the given type and commandResult.

Uses the correlation data of the current Unit of Work, if present.

Parameters:

type - The type for this CommandResultMessage.

commandResult - The result for this CommandResultMessage.

GenericCommandResultMessage

@Deprecated
public GenericCommandResultMessage(@Nonnull
 MessageType type,
 @Nonnull
 Throwable exception)

Deprecated.

Constructs a GenericCommandResultMessage for the given type and exception.

Uses the correlation data of the current Unit of Work, if present.

Parameters:

type - The type for this CommandResultMessage.

exception - The Throwable describing the error representing the response of this CommandResultMessage.

GenericCommandResultMessage

public GenericCommandResultMessage(@Nonnull
 MessageType type,
 @Nullable
 Object commandResult,
 @Nonnull
 Map<String,String> metadata)

Constructs a GenericCommandResultMessage for the given type, commandResult, and metadata.

Parameters:

type - The type for this CommandResultMessage.

commandResult - The result for this CommandResultMessage.

metadata - The metadata for this CommandResultMessage.

GenericCommandResultMessage

@Deprecated
public GenericCommandResultMessage(@Nonnull
 MessageType type,
 @Nonnull
 Throwable exception,
 @Nonnull
 Map<String,String> metadata)

Deprecated.

Constructs a GenericCommandResultMessage for the given type, exception, and metadata.

Parameters:

type - The type for this CommandResultMessage.

exception - The Throwable describing the error representing the response of this CommandResultMessage.

metadata - The metadata for this CommandResultMessage.

GenericCommandResultMessage

public GenericCommandResultMessage(@Nonnull
 Message delegate)

Constructs a GenericCommandResultMessage for the given delegate, intended to reconstruct another CommandResultMessage.

Unlike the other constructors, this constructor will not attempt to retrieve any correlation data from the Unit of Work.

Parameters:

delegate - The Message containing payload, type, identifier and metadata for the QueryResponseMessage to reconstruct.

Method Details

withMetadata

@Nonnull
public CommandResultMessage withMetadata(@Nonnull
 Map<String,String> metadata)

Description copied from interface: Message

Returns a copy of this Message (implementation) with the given metadata.

All other fields, like for example the Message.payload(), remain unchanged.

While the implementation returned may be different from the implementation of this, implementations must take special care in returning the same type of Message to prevent errors further downstream.

Specified by:

withMetadata in interface CommandResultMessage

Specified by:

withMetadata in interface Message

Specified by:

withMetadata in interface ResultMessage

Overrides:

withMetadata in class GenericResultMessage

Parameters:

metadata - The new metadata for the Message.

Returns:

A copy of this Message (implementation) with the given metadata.

andMetadata

@Nonnull
public CommandResultMessage andMetadata(@Nonnull
 Map<String,String> metadata)

Description copied from interface: Message

Returns a copy of this Message (implementation) with its metadata merged with the given metadata.

All other fields, like for example the Message.payload(), remain unchanged.

Specified by:

andMetadata in interface CommandResultMessage

Specified by:

andMetadata in interface Message

Specified by:

andMetadata in interface ResultMessage

Overrides:

andMetadata in class GenericResultMessage

Parameters:

metadata - The metadata to merge with.

Returns:

A copy of this Message (implementation) with the given metadata.

withConvertedPayload

@Nonnull
public CommandResultMessage withConvertedPayload(@Nonnull
 Type type,
 @Nonnull
 Converter converter)

Description copied from interface: Message

Returns a new Message implementation with its Message.payload() converted to the given type by the given converter. This new Message is effectively a copy of this Message with a renewed payload and Message.payloadType().

Will return the this instance if the payload type is assignable from the converted result.

Specified by:

withConvertedPayload in interface CommandResultMessage

Specified by:

withConvertedPayload in interface Message

Specified by:

withConvertedPayload in interface ResultMessage

Overrides:

withConvertedPayload in class GenericResultMessage

Parameters:

type - The type to convert the Message.payload() to.

converter - The converter to convert the Message.payload() with.

Returns:

A new Message implementation with its Message.payload() converted to the given type by the given converter.

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

Returns:

The type of the message.