Package org.axonframework.messaging.queryhandling

Class GenericSubscriptionQueryUpdateMessage

java.lang.Object

org.axonframework.messaging.core.MessageDecorator

org.axonframework.messaging.core.GenericResultMessage

org.axonframework.messaging.queryhandling.GenericSubscriptionQueryUpdateMessage

All Implemented Interfaces:

Message, ResultMessage, QueryResponseMessage, SubscriptionQueryUpdateMessage

public class GenericSubscriptionQueryUpdateMessage
extends GenericResultMessage
implements SubscriptionQueryUpdateMessage

Generic implementation of the SubscriptionQueryUpdateMessage interface holding incremental update of a subscription query.

Since:

3.3.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
GenericSubscriptionQueryUpdateMessage(Message delegate)	Initializes a new decorator with given delegate message.
GenericSubscriptionQueryUpdateMessage(MessageType type, Object payload)	Constructs a GenericSubscriptionQueryUpdateMessage for the given type and payload.
GenericSubscriptionQueryUpdateMessage(MessageType type, P payload, Class<P> declaredUpdateType)	Constructs a GenericSubscriptionQueryUpdateMessage for the given type and payload.
GenericSubscriptionQueryUpdateMessage(MessageType type, P payload, Class<P> declaredUpdateType, Map<String,String> metadata)	Constructs a GenericSubscriptionQueryUpdateMessage for the given type, payload, and metadata.

Method Summary

Modifier and Type	Method	Description
SubscriptionQueryUpdateMessage	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().
SubscriptionQueryUpdateMessage	withConvertedPayload(Type type, Converter converter)	Returns a new Message implementation with its Message.payload() converted to the given type by the given converter.
SubscriptionQueryUpdateMessage	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.core.Message

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

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

withConvertedPayload, withConvertedPayload

Constructor Details

GenericSubscriptionQueryUpdateMessage

public GenericSubscriptionQueryUpdateMessage(@Nonnull
 MessageType type,
 @Nullable
 Object payload)

Constructs a GenericSubscriptionQueryUpdateMessage for the given type and payload.

The Metadata defaults to an empty instance.

Parameters:

type - The type for this SubscriptionQueryUpdateMessage.

payload - The payload of type U for this SubscriptionQueryUpdateMessage representing an incremental update.

GenericSubscriptionQueryUpdateMessage

public GenericSubscriptionQueryUpdateMessage(@Nonnull
 MessageType type,
 @Nullable
 P payload,
 @Nonnull
 Class<P> declaredUpdateType)

Constructs a GenericSubscriptionQueryUpdateMessage for the given type and payload.

The Metadata defaults to an empty instance.

Type Parameters:

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

Parameters:

type - The type for this SubscriptionQueryUpdateMessage.

payload - The payload of type U for this SubscriptionQueryUpdateMessage representing an incremental update.

declaredUpdateType - The declared update type of this SubscriptionQueryUpdateMessage.

GenericSubscriptionQueryUpdateMessage

public GenericSubscriptionQueryUpdateMessage(@Nonnull
 MessageType type,
 @Nullable
 P payload,
 @Nonnull
 Class<P> declaredUpdateType,
 @Nonnull
 Map<String,String> metadata)

Constructs a GenericSubscriptionQueryUpdateMessage for the given type, payload, and metadata.

Type Parameters:

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

Parameters:

type - The type for this SubscriptionQueryUpdateMessage.

payload - The payload of type U for this SubscriptionQueryUpdateMessage representing an incremental update.

declaredUpdateType - The declared update type of this SubscriptionQueryUpdateMessage.

metadata - The metadata for this SubscriptionQueryUpdateMessage.

GenericSubscriptionQueryUpdateMessage

public GenericSubscriptionQueryUpdateMessage(@Nonnull
 Message delegate)

Initializes a new decorator with given delegate message. The decorator delegates to the delegate for the message's payload, metadata and identifier.

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 SubscriptionQueryUpdateMessage 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

Specified by:

withMetadata in interface SubscriptionQueryUpdateMessage

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

Specified by:

andMetadata in interface QueryResponseMessage

Specified by:

andMetadata in interface ResultMessage

Specified by:

andMetadata in interface SubscriptionQueryUpdateMessage

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 SubscriptionQueryUpdateMessage 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

Specified by:

withConvertedPayload in interface SubscriptionQueryUpdateMessage

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.