Package org.axonframework.messaging.eventhandling.replay

Class GenericReplayStatusChanged

java.lang.Object

org.axonframework.messaging.core.MessageDecorator

org.axonframework.messaging.eventhandling.replay.GenericReplayStatusChanged

All Implemented Interfaces:

Message, ReplayStatusChanged

@Internal
public class GenericReplayStatusChanged
extends MessageDecorator
implements ReplayStatusChanged

Generic implementation of the ReplayStatusChanged interface.

Since:

5.1.0

Author:

Simon Zambrovski, Stefan Dragisic, Steven van Beelen

Field Summary

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

RESOURCE_KEY

Constructor Summary

Constructors

Constructor	Description
GenericReplayStatusChanged(ReplayStatus status, @Nullable Object payload)	Constructs a GenericReplayStatusChange for the given status and payload.
GenericReplayStatusChanged(ReplayStatus status, @Nullable Object payload, Map<String,@Nullable String> metadata)	Constructs a GenericReplayStatusChange for the given status, payload, and metadata.
GenericReplayStatusChanged(ReplayStatus status, Message delegate)	Constructs a GenericReplayStatusChange for the given delegate, intended to reconstruct another ReplayStatusChanged.

Method Summary

Modifier and Type	Method	Description
ReplayStatusChanged	andMetadata(Map<String,@Nullable String> additionalMetadata)	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().
ReplayStatus	status()	The status changed to as notified by this message.
ReplayStatusChanged	withConvertedPayload(Type type, Converter converter)	Returns a new Message implementation with its Message.payload() converted to the given type by the given converter.
ReplayStatusChanged	withMetadata(Map<String,String> metadata)	Returns a copy of this Message (implementation) with the given metadata.

Methods inherited from class org.axonframework.messaging.core.MessageDecorator

delegate, describeTo, identifier, metadata, payload, payloadAs, 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.eventhandling.replay.ReplayStatusChanged

withConvertedPayload, withConvertedPayload

Constructor Details

GenericReplayStatusChanged

public GenericReplayStatusChanged(ReplayStatus status,
 @Nullable Object payload)

Constructs a GenericReplayStatusChange for the given status and payload.

The Metadata defaults to an empty instance.

Parameters:

status - the status changed to as notified by this message

payload - the payload for this ReplayStatusChanged

GenericReplayStatusChanged

public GenericReplayStatusChanged(ReplayStatus status,
 @Nullable Object payload,
 Map<String,@Nullable String> metadata)

Constructs a GenericReplayStatusChange for the given status, payload, and metadata.

Parameters:

status - the status changed to as notified by this message

payload - the payload for this ReplayStatusChanged

metadata - the metadata for this ReplayStatusChanged

GenericReplayStatusChanged

public GenericReplayStatusChanged(ReplayStatus status,
 Message delegate)

Constructs a GenericReplayStatusChange for the given delegate, intended to reconstruct another ReplayStatusChanged.

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

Parameters:

status - the status changed to as notified by this message

delegate - the Message containing payload, type, identifier and metadata for the EventMessage to reconstruct

Method Details

status

public ReplayStatus status()

Description copied from interface: ReplayStatusChanged

The status changed to as notified by this message.

Specified by:

status in interface ReplayStatusChanged

Returns:

the status changed to as notified by this message

withMetadata

public ReplayStatusChanged 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 Message

Specified by:

withMetadata in interface ReplayStatusChanged

Parameters:

metadata - The new metadata for the Message.

Returns:

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

andMetadata

public ReplayStatusChanged andMetadata(Map<String,@Nullable 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 Message

Specified by:

andMetadata in interface ReplayStatusChanged

Parameters:

additionalMetadata - The metadata to merge with.

Returns:

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

withConvertedPayload

public ReplayStatusChanged 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 Message

Specified by:

withConvertedPayload in interface ReplayStatusChanged

Overrides:

withConvertedPayload in class MessageDecorator

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 MessageDecorator

Returns:

The type of the message.