org.axonframework.queryhandling

Class GenericSubscriptionQueryUpdateMessage<U>

java.lang.Object

org.axonframework.messaging.MessageDecorator<R>

org.axonframework.messaging.GenericResultMessage<U>

org.axonframework.queryhandling.GenericSubscriptionQueryUpdateMessage<U>

Type Parameters:

U - type of incremental update

All Implemented Interfaces:

Serializable, Message<U>, ResultMessage<U>, SubscriptionQueryUpdateMessage<U>

public class GenericSubscriptionQueryUpdateMessage<U>
extends GenericResultMessage<U>
implements SubscriptionQueryUpdateMessage<U>

Generic SubscriptionQueryUpdateMessage which holds incremental update of an subscription query.

Since:

3.3

Author:

Milan Savic

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
	GenericSubscriptionQueryUpdateMessage(Class<U> declaredType, Throwable exception, Map<String,?> metaData) Initialize the subscription query update message with given declaredType, exception and metaData.
	GenericSubscriptionQueryUpdateMessage(Class<U> declaredType, U payload) Initializes GenericSubscriptionQueryUpdateMessage with incremental update of provided declaredType.
	GenericSubscriptionQueryUpdateMessage(Class<U> declaredType, U payload, Map<String,?> metaData) Initializes GenericSubscriptionQueryUpdateMessage with incremental update of provided declaredType and metaData.
protected	GenericSubscriptionQueryUpdateMessage(Message<U> delegate) Initializes a new decorator with given delegate message.
	GenericSubscriptionQueryUpdateMessage(U payload) Initializes GenericSubscriptionQueryUpdateMessage with incremental update.

Method Summary

Modifier and Type	Method and Description
GenericSubscriptionQueryUpdateMessage<U>	andMetaData(Map<String,?> metaData) Returns a copy of this Message with it MetaData merged with the given metaData.
static <T> SubscriptionQueryUpdateMessage<T>	asUpdateMessage(Class<T> declaredType, Throwable exception) Creates a GenericSubscriptionQueryUpdateMessage with the given declaredType and exception result.
static <T> SubscriptionQueryUpdateMessage<T>	asUpdateMessage(Object payload) Creates GenericSubscriptionQueryUpdateMessage from provided payload which represents incremental update.
protected String	describeType() Describe the type of message, used in MessageDecorator.toString().
GenericSubscriptionQueryUpdateMessage<U>	withMetaData(Map<String,?> metaData) Returns a copy of this Message with the given metaData.

Methods inherited from class org.axonframework.messaging.GenericResultMessage

asResultMessage, asResultMessage, describeTo, getPayload, isExceptional, optionalExceptionResult, serializePayload

Methods inherited from class org.axonframework.messaging.MessageDecorator

getDelegate, getIdentifier, getMetaData, getPayloadType, serializeMetaData, 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.ResultMessage

exceptionDetails, exceptionResult, isExceptional, optionalExceptionResult, serializeExceptionResult, serializePayload

Methods inherited from interface org.axonframework.messaging.Message

getIdentifier, getMetaData, getPayload, getPayloadType, serializeMetaData

Constructor Detail

GenericSubscriptionQueryUpdateMessage

public GenericSubscriptionQueryUpdateMessage(U payload)

Initializes GenericSubscriptionQueryUpdateMessage with incremental update.

Parameters:

payload - payload of the message which represent incremental update

GenericSubscriptionQueryUpdateMessage

public GenericSubscriptionQueryUpdateMessage(Class<U> declaredType,
                                             U payload)

Initializes GenericSubscriptionQueryUpdateMessage with incremental update of provided declaredType.

Parameters:

declaredType - the type of the update

payload - the payload of the update

GenericSubscriptionQueryUpdateMessage

public GenericSubscriptionQueryUpdateMessage(Class<U> declaredType,
                                             U payload,
                                             Map<String,?> metaData)

Initializes GenericSubscriptionQueryUpdateMessage with incremental update of provided declaredType and metaData.

Parameters:

declaredType - the type of the update

payload - the payload of the update

metaData - the metadata of the update

GenericSubscriptionQueryUpdateMessage

public GenericSubscriptionQueryUpdateMessage(Class<U> declaredType,
                                             Throwable exception,
                                             Map<String,?> metaData)

Initialize the subscription query update message with given declaredType, exception and metaData.

Parameters:

declaredType - The declared type of the Subscription Query Update Message to be created

exception - The exception describing the cause of an error

metaData - The meta data to contain in the message

GenericSubscriptionQueryUpdateMessage

protected GenericSubscriptionQueryUpdateMessage(Message<U> delegate)

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

Parameters:

delegate - the message delegate

Method Detail

asUpdateMessage

public static <T> SubscriptionQueryUpdateMessage<T> asUpdateMessage(Object payload)

Creates GenericSubscriptionQueryUpdateMessage from provided payload which represents incremental update. The provided payload may not be null.

Type Parameters:

T - type of the GenericSubscriptionQueryUpdateMessage

Parameters:

payload - incremental update

Returns:

created a SubscriptionQueryUpdateMessage with the given payload.

asUpdateMessage

public static <T> SubscriptionQueryUpdateMessage<T> asUpdateMessage(Class<T> declaredType,
                                                                    Throwable exception)

Creates a GenericSubscriptionQueryUpdateMessage with the given declaredType and exception result.

Type Parameters:

T - type of the GenericSubscriptionQueryUpdateMessage

Parameters:

declaredType - The declared type of the Subscription Query Update Message to be created

exception - The exception describing the cause of an error

Returns:

a message containing exception result

withMetaData

public GenericSubscriptionQueryUpdateMessage<U> withMetaData(@Nonnull
                                                             Map<String,?> metaData)

Description copied from interface: Message

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

While the implementation returned may be different than the implementation of this, implementations must take special care in returning the same type of Message (e.g. EventMessage, DomainEventMessage) to prevent errors further downstream.

Specified by:

withMetaData in interface Message<U>

Specified by:

withMetaData in interface ResultMessage<U>

Specified by:

withMetaData in interface SubscriptionQueryUpdateMessage<U>

Overrides:

withMetaData in class GenericResultMessage<U>

Parameters:

metaData - The new MetaData for the Message

Returns:

a copy of this message with the given MetaData

andMetaData

public GenericSubscriptionQueryUpdateMessage<U> andMetaData(@Nonnull
                                                            Map<String,?> metaData)

Description copied from interface: Message

Returns a copy of this Message with it MetaData merged with the given metaData. The payload remains unchanged.

Specified by:

andMetaData in interface Message<U>

Specified by:

andMetaData in interface ResultMessage<U>

Specified by:

andMetaData in interface SubscriptionQueryUpdateMessage<U>

Overrides:

andMetaData in class GenericResultMessage<U>

Parameters:

metaData - The MetaData to merge with

Returns:

a copy of this message with the given MetaData

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

Returns:

the type of message