Package org.axonframework.messaging.eventhandling.replay

Class GenericResetContext

java.lang.Object

org.axonframework.messaging.core.MessageDecorator

org.axonframework.messaging.eventhandling.replay.GenericResetContext

All Implemented Interfaces:

Message, ResetContext

public class GenericResetContext
extends MessageDecorator
implements ResetContext

Generic implementation of the ResetContext interface.

Since:

4.4.0

Author:

Steven van Beelen

Field Summary

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

RESOURCE_KEY

Constructor Summary

Constructors

Constructor	Description
GenericResetContext(Message delegate)	Constructs a GenericResetContext for the given delegate, intended to reconstruct another ResetContext.
GenericResetContext(MessageType type, Object payload)	Constructs a GenericResetContext for the given type and payload.
GenericResetContext(MessageType type, Object payload, Map<String,String> metadata)	Constructs a GenericResetContext for the given type, payload, and metadata.

Method Summary

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

withConvertedPayload, withConvertedPayload

Constructor Details

GenericResetContext

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

Constructs a GenericResetContext for the given type and payload.

The Metadata defaults to an empty instance.

Parameters:

type - The type for this ResetContext.

payload - The payload for this ResetContext.

GenericResetContext

public GenericResetContext(@Nonnull
 MessageType type,
 @Nullable
 Object payload,
 @Nonnull
 Map<String,String> metadata)

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

Parameters:

type - The type for this ResetContext.

payload - The payload for this ResetContext.

metadata - The metadata for this ResetContext.

GenericResetContext

public GenericResetContext(@Nonnull
 Message delegate)

Constructs a GenericResetContext for the given delegate, intended to reconstruct another ResetContext.

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 EventMessage to reconstruct.

Method Details

withMetadata

@Nonnull
public ResetContext 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 ResetContext

Parameters:

metadata - The new metadata for the Message.

Returns:

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

andMetadata

@Nonnull
public ResetContext andMetadata(@Nonnull
 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 Message

Specified by:

andMetadata in interface ResetContext

Parameters:

additionalMetadata - The metadata to merge with.

Returns:

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

withConvertedPayload

@Nonnull
public ResetContext 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 ResetContext

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.