Package org.axonframework.messaging.queryhandling

Class GenericQueryResponseMessage

java.lang.Object

org.axonframework.messaging.core.MessageDecorator

org.axonframework.messaging.core.GenericResultMessage

org.axonframework.messaging.queryhandling.GenericQueryResponseMessage

All Implemented Interfaces:

Message, ResultMessage, QueryResponseMessage

public class GenericQueryResponseMessage
extends GenericResultMessage
implements QueryResponseMessage

Generic implementation of the QueryResponseMessage interface.

Since:

3.2.0

Author:

Allard Buijze, Steven van Beelen

Field Summary

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

RESOURCE_KEY

Constructor Summary

Constructors

Constructor	Description
GenericQueryResponseMessage(Message delegate)	Constructs a GenericQueryResponseMessage for the given delegate, intended to reconstruct another QueryResponseMessage.
GenericQueryResponseMessage(MessageType type, Object result)	Constructs a GenericQueryResponseMessage for the given type and payload.
GenericQueryResponseMessage(MessageType type, Object result, Map<String,String> metadata)	Constructs a GenericQueryResponseMessage for the given type, result, and metadata.
GenericQueryResponseMessage(MessageType type, R result, Class<R> declaredResultType)	Constructs a GenericQueryResponseMessage for the given type and payload.
GenericQueryResponseMessage(MessageType type, R result, Class<R> declaredResultType, Map<String,String> metadata)	Constructs a GenericQueryResponseMessage for the given type, result, and metadata.

Method Summary

Modifier and Type	Method	Description
QueryResponseMessage	andMetadata(Map<String,String> additionalMetadata)	Returns a copy of this Message (implementation) with its metadata merged with the given metadata.
QueryResponseMessage	withConvertedPayload(Type type, Converter converter)	Returns a new Message implementation with its Message.payload() converted to the given type by the given converter.
QueryResponseMessage	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, describeType

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.core.Message

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

Methods inherited from interface org.axonframework.messaging.queryhandling.QueryResponseMessage

withConvertedPayload, withConvertedPayload

Constructor Details

GenericQueryResponseMessage

public GenericQueryResponseMessage(@Nonnull
 MessageType type,
 @Nullable
 Object result)

Constructs a GenericQueryResponseMessage for the given type and payload.

The Metadata defaults to an empty instance.

Parameters:

type - The type for this QueryResponseMessage.

result - The result for this QueryResponseMessage.

GenericQueryResponseMessage

public GenericQueryResponseMessage(@Nonnull
 MessageType type,
 @Nullable
 R result,
 @Nonnull
 Class<R> declaredResultType)

Constructs a GenericQueryResponseMessage for the given type and payload.

This constructor allows the actual result to be null. The Metadata defaults to an empty instance.

Type Parameters:

R - The generic type of the expected payload of the resulting object.

Parameters:

type - The type for this QueryResponseMessage.

result - The result of type R for this QueryResponseMessage. May be null.

declaredResultType - The declared result type of this QueryResponseMessage.

GenericQueryResponseMessage

public GenericQueryResponseMessage(@Nonnull
 MessageType type,
 @Nullable
 Object result,
 @Nonnull
 Map<String,String> metadata)

Constructs a GenericQueryResponseMessage for the given type, result, and metadata.

This constructor allows the actual result to be null.

Parameters:

type - The type for this QueryResponseMessage.

result - The result for this QueryResponseMessage. May be null.

metadata - The metadata for this QueryResponseMessage.

GenericQueryResponseMessage

public GenericQueryResponseMessage(@Nonnull
 MessageType type,
 @Nullable
 R result,
 @Nonnull
 Class<R> declaredResultType,
 @Nonnull
 Map<String,String> metadata)

Constructs a GenericQueryResponseMessage for the given type, result, and metadata.

This constructor allows the actual result to be null.

Type Parameters:

R - The generic type of the expected payload of the resulting object.

Parameters:

type - The type for this QueryResponseMessage.

result - The result of type R for this QueryResponseMessage. May be null.

declaredResultType - The declared result type of this QueryResponseMessage.

metadata - The metadata for this QueryResponseMessage.

GenericQueryResponseMessage

public GenericQueryResponseMessage(@Nonnull
 Message delegate)

Constructs a GenericQueryResponseMessage for the given delegate, intended to reconstruct another QueryResponseMessage.

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 QueryResponseMessage 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 Message

Specified by:

withMetadata in interface QueryResponseMessage

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 QueryResponseMessage andMetadata(@Nonnull
 Map<String,String> additionalMetadata)

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

Specified by:

andMetadata in interface QueryResponseMessage

Specified by:

andMetadata in interface ResultMessage

Overrides:

andMetadata in class GenericResultMessage

Parameters:

additionalMetadata - The metadata to merge with.

Returns:

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

withConvertedPayload

@Nonnull
public QueryResponseMessage 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 Message

Specified by:

withConvertedPayload in interface QueryResponseMessage

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.