Package org.axonframework.deadline

Interface DeadlineMessage

All Superinterfaces:

EventMessage, Message

All Known Implementing Classes:

GenericDeadlineMessage

public interface DeadlineMessage
extends EventMessage

An EventMessage for a deadline, specified by its deadlineName and optionally containing a deadlinePayload.

Implementations of the 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.0

Author:

Milan Savic, Steven van Beelen

Field Summary

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

RESOURCE_KEY

Method Summary

Modifier and Type	Method	Description
DeadlineMessage	andMetadata(Map<String,String> additionalMetadata)	Returns a copy of this Message (implementation) with its metadata merged with the given metadata.
String	getDeadlineName()	Returns the name of the deadline to be handled.
default DeadlineMessage	withConvertedPayload(Class<?> type, Converter converter)	Returns a new Message implementation with its Message.payload() converted to the given type by the given converter.
DeadlineMessage	withConvertedPayload(Type type, Converter converter)	Returns a new Message implementation with its Message.payload() converted to the given type by the given converter.
default DeadlineMessage	withConvertedPayload(TypeReference<?> type, Converter converter)	Returns a new Message implementation with its Message.payload() converted to the given type by the given converter.
DeadlineMessage	withMetadata(Map<String,String> metadata)	Returns a copy of this Message (implementation) with the given metadata.

Methods inherited from interface org.axonframework.messaging.eventhandling.EventMessage

identifier, timestamp

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

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

Method Details

getDeadlineName

String getDeadlineName()

Returns the name of the deadline to be handled.

Returns:

the name of the deadline

withMetadata

DeadlineMessage withMetadata(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 EventMessage

Specified by:

withMetadata in interface Message

Parameters:

metadata - The new metadata for the Message.

Returns:

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

andMetadata

DeadlineMessage andMetadata(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 EventMessage

Specified by:

andMetadata in interface Message

Parameters:

additionalMetadata - The metadata to merge with.

Returns:

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

withConvertedPayload

default DeadlineMessage withConvertedPayload(Class<?> type,
 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 EventMessage

Specified by:

withConvertedPayload in interface Message

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

default DeadlineMessage withConvertedPayload(TypeReference<?> type,
 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 EventMessage

Specified by:

withConvertedPayload in interface Message

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

DeadlineMessage withConvertedPayload(Type type,
 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 EventMessage

Specified by:

withConvertedPayload in interface Message

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.