org.axonframework.queryhandling

Class GenericQueryResponseMessage<R>

java.lang.Object

org.axonframework.messaging.MessageDecorator<R>

org.axonframework.queryhandling.GenericQueryResponseMessage<R>

Type Parameters:

R - The type of return value contained in this response

All Implemented Interfaces:

Serializable, Message<R>, QueryResponseMessage<R>, SerializationAware

public class GenericQueryResponseMessage<R>
extends MessageDecorator<R>
implements QueryResponseMessage<R>

QueryResponseMessage implementation that takes all properties as constructor parameters.

Since:

3.2

Author:

Allard Buijze

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GenericQueryResponseMessage(Message<R> delegate) Copy-constructor that takes the payload, meta data and message identifier of the given delegate for this message.
GenericQueryResponseMessage(R result) Initialize the response message with given result.
GenericQueryResponseMessage(R result, Map<String,?> metaData) Initialize the response message with given result.

Method Summary

Modifier and Type	Method and Description
QueryResponseMessage<R>	andMetaData(Map<String,?> additionalMetaData) Returns a copy of this QueryResponseMessage with its MetaData merged with given metaData.
static <R> QueryResponseMessage<R>	asResponseMessage(Object result) Creates a QueryResponseMessage for the given result.
QueryResponseMessage<R>	withMetaData(Map<String,?> metaData) Returns a copy of this QueryResponseMessage with the given metaData.

Methods inherited from class org.axonframework.messaging.MessageDecorator

describeTo, describeType, getDelegate, getIdentifier, getMetaData, getPayload, getPayloadType, serializeMetaData, serializePayload, 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

Constructor Detail

GenericQueryResponseMessage

public GenericQueryResponseMessage(R result)

Initialize the response message with given result.

Parameters:

result - The result reported by the Query Handler

GenericQueryResponseMessage

public GenericQueryResponseMessage(R result,
                                   Map<String,?> metaData)

Initialize the response message with given result.

Parameters:

result - The result reported by the Query Handler

metaData - The meta data to contain in the message

GenericQueryResponseMessage

public GenericQueryResponseMessage(Message<R> delegate)

Copy-constructor that takes the payload, meta data and message identifier of the given delegate for this message.

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

Parameters:

delegate - The message to retrieve message details from

Method Detail

asResponseMessage

public static <R> QueryResponseMessage<R> asResponseMessage(Object result)

Creates a QueryResponseMessage for the given result. If result already implements QueryResponseMessage, it is returned directly. Otherwise a new QueryResponseMessage is created with the result as payload. An attempt is made to detect collection-like structures (see CollectionUtils.asCollection(Object)) in the given result, converting it to a Collection is possible.

Type Parameters:

R - The type of response expected

Parameters:

result - The result of a Query, to be wrapped in a QueryResponseMessage

Returns:

a QueryResponseMessage for the given result, or the result itself, if already a QueryResponseMessage.

withMetaData

public QueryResponseMessage<R> withMetaData(Map<String,?> metaData)

Description copied from interface: QueryResponseMessage

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

Specified by:

withMetaData in interface Message<R>

Specified by:

withMetaData in interface QueryResponseMessage<R>

Parameters:

metaData - The new MetaData for the QueryResponseMessage

Returns:

a copy of this message with the given MetaData

andMetaData

public QueryResponseMessage<R> andMetaData(Map<String,?> additionalMetaData)

Description copied from interface: QueryResponseMessage

Returns a copy of this QueryResponseMessage with its MetaData merged with given metaData. The payload remains unchanged.

Specified by:

andMetaData in interface Message<R>

Specified by:

andMetaData in interface QueryResponseMessage<R>

Parameters:

additionalMetaData - The MetaData to merge into the QueryResponseMessage

Returns:

a copy of this message with the given additional MetaData