Package org.axonframework.messaging.core

Interface ResultMessage

All Superinterfaces:

Message

All Known Subinterfaces:

CommandResultMessage, QueryResponseMessage, SubscriptionQueryUpdateMessage

All Known Implementing Classes:

GenericCommandResultMessage, GenericQueryResponseMessage, GenericResultMessage, GenericSubscriptionQueryUpdateMessage

public interface ResultMessage
extends Message

A Message that represents a result of handling some form of a request message.

Since:

4.0.0

Author:

Milan Savic

Field Summary

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

RESOURCE_KEY

Method Summary

Modifier and Type	Method	Description
ResultMessage	andMetadata(Map<String,String> metadata)	Returns a copy of this Message (implementation) with its metadata merged with the given metadata.
default ResultMessage	withConvertedPayload(Class<?> type, Converter converter)	Returns a new Message implementation with its Message.payload() converted to the given type by the given converter.
ResultMessage	withConvertedPayload(Type type, Converter converter)	Returns a new Message implementation with its Message.payload() converted to the given type by the given converter.
default ResultMessage	withConvertedPayload(TypeReference<?> type, Converter converter)	Returns a new Message implementation with its Message.payload() converted to the given type by the given converter.
ResultMessage	withMetadata(Map<String,String> metadata)	Returns a copy of this Message (implementation) with the given metadata.

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

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

Method Details

withMetadata

ResultMessage withMetadata(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 Message

Parameters:

metadata - The new metadata for the Message.

Returns:

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

andMetadata

ResultMessage andMetadata(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 Message

Parameters:

metadata - The metadata to merge with.

Returns:

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

withConvertedPayload

default ResultMessage withConvertedPayload(Class<?> type,
 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 Message

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.

withConvertedPayload

default ResultMessage withConvertedPayload(TypeReference<?> type,
 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 Message

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.

withConvertedPayload

ResultMessage withConvertedPayload(Type type,
 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 Message

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.