Package org.axonframework.messaging.queryhandling

Interface QueryResponseMessage

All Superinterfaces:

Message, ResultMessage

All Known Subinterfaces:

SubscriptionQueryUpdateMessage

All Known Implementing Classes:

GenericQueryResponseMessage, GenericSubscriptionQueryUpdateMessage

public interface QueryResponseMessage
extends ResultMessage

A ResultMessage implementation that contains the result of query handling.

Since:

3.2.0

Author:

Allard Buijze

Field Summary

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

RESOURCE_KEY

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.
default QueryResponseMessage	withConvertedPayload(Class<?> type, Converter converter)	Returns a new Message implementation with its Message.payload() converted to the given type by the given converter.
QueryResponseMessage	withConvertedPayload(Type type, Converter converter)	Returns a new Message implementation with its Message.payload() converted to the given type by the given converter.
default QueryResponseMessage	withConvertedPayload(TypeReference<?> 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 interface org.axonframework.messaging.core.Message

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

Method Details

withMetadata

@Nonnull
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 ResultMessage

Parameters:

metadata - The new metadata for the Message.

Returns:

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

andMetadata

@Nonnull
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 ResultMessage

Parameters:

additionalMetadata - The metadata to merge with.

Returns:

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

withConvertedPayload

@Nonnull
default QueryResponseMessage withConvertedPayload(@Nonnull
 Class<?> 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 ResultMessage

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

@Nonnull
default QueryResponseMessage withConvertedPayload(@Nonnull
 TypeReference<?> 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 ResultMessage

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

@Nonnull
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 ResultMessage

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.