org.axonframework.deadline

Interface DeadlineMessage<T>

Type Parameters:

T - The type of payload contained in this Message; may be Void if no payload was provided

All Superinterfaces:

EventMessage<T>, Message<T>, Serializable

All Known Implementing Classes:

GenericDeadlineMessage

public interface DeadlineMessage<T>
extends EventMessage<T>

Represents a Message for a Deadline, specified by its deadline name and optionally containing a deadline payload. Implementations of DeadlineMessage represent a fact (it's a specialization of EventMessage) that some deadline was reached. The optional payload contains relevant data of the scheduled deadline.

Since:

3.3

Author:

Milan Savic, Steven van Beelen

Method Summary

Modifier and Type	Method and Description
DeadlineMessage<T>	andMetaData(Map<String,?> additionalMetaData) Returns a copy of this DeadlineMessage with its MetaData merged with given additionalMetaData.
String	getDeadlineName() Retrieve a String representing the name of this DeadlineMessage.
DeadlineMessage<T>	withMetaData(Map<String,?> metaData) Returns a copy of this DeadlineMessage with the given metaData.

Methods inherited from interface org.axonframework.eventhandling.EventMessage

getIdentifier, getTimestamp

Methods inherited from interface org.axonframework.messaging.Message

getMetaData, getPayload, getPayloadType, serializeMetaData, serializePayload

Method Detail

getDeadlineName

String getDeadlineName()

Retrieve a String representing the name of this DeadlineMessage.

Returns:

a String representing the name of this DeadlineMessage

withMetaData

DeadlineMessage<T> withMetaData(@Nonnull
                                Map<String,?> metaData)

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

Specified by:

withMetaData in interface EventMessage<T>

Specified by:

withMetaData in interface Message<T>

Parameters:

metaData - The new MetaData for the Message

Returns:

a copy of this message with the given MetaData

andMetaData

DeadlineMessage<T> andMetaData(@Nonnull
                               Map<String,?> additionalMetaData)

Returns a copy of this DeadlineMessage with its MetaData merged with given additionalMetaData. The payload remains unchanged.

Specified by:

andMetaData in interface EventMessage<T>

Specified by:

andMetaData in interface Message<T>

Parameters:

additionalMetaData - The MetaData to merge into the DeadlineMessage

Returns:

a copy of this message with added additional MetaData