Package org.axonframework.eventsourcing.eventstore

Class SnapshotEventMessage

java.lang.Object

org.axonframework.messaging.core.MessageDecorator

org.axonframework.messaging.eventhandling.GenericEventMessage

org.axonframework.eventsourcing.eventstore.SnapshotEventMessage

All Implemented Interfaces:

Message, EventMessage

@Internal
public class SnapshotEventMessage
extends GenericEventMessage

Message containing a snapshot.

This message can be emitted when calling EventStoreTransaction.source(SourcingCondition) when using the snapshot sourcing strategy and a suitable snapshot was available.

Since:

5.1.0

Author:

John Hendrikx

Field Summary

Fields inherited from class org.axonframework.messaging.eventhandling.GenericEventMessage

clock

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

RESOURCE_KEY

Constructor Summary

Constructors

Constructor	Description
SnapshotEventMessage(Snapshot snapshot)	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
Snapshot	payload()	Returns the payload of this Message.

Methods inherited from class org.axonframework.messaging.eventhandling.GenericEventMessage

andMetadata, describeTo, describeType, timestamp, withConvertedPayload, withConverter, withMetadata

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

delegate, identifier, metadata, 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.eventhandling.EventMessage

identifier, withConvertedPayload, withConvertedPayload

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

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

Constructor Details

SnapshotEventMessage

public SnapshotEventMessage(Snapshot snapshot)

Constructs a new instance.

Parameters:

snapshot - the snapshot, cannot be null

Throws:

NullPointerException - when any argument is null

Method Details

payload

public Snapshot payload()

Description copied from interface: Message

Returns the payload of this Message.

The payload is the application-specific information.

Specified by:

payload in interface Message

Overrides:

payload in class MessageDecorator

Returns:

The payload of this Message.