Package com.opencqrs.framework.command

Interface EventSpecifierDsl

public interface EventSpecifierDsl

Fluent API for specifying the attributes of a single given event. Instances are passed to the consumer in GivenDsl.event(java.util.function.Consumer).

The only required method is payload(Object) - all other attributes have the following defaults if not explicitly specified via this:

• subject - uses the value from GivenDsl.usingSubject(String) or the command's subject
• time - uses the value from GivenDsl.time(Instant) or Instant.now()
• id - generated randomly
• metaData - empty map

Example:

 fixture.given()
     .event(e -> e
         .payload(new OrderPlacedEvent("order-123", "customer-456"))
         .subject("/orders/order-123")
         .time(Instant.parse("2024-01-15T14:30:00Z"))
         .id("event-001")
         .metaData(Map.of("userId", "user-789")))
     .when(...)
 

Method Summary

Modifier and Type	Method	Description
EventSpecifierDsl	id(String id)	Sets the unique identifier for this event.
EventSpecifierDsl	metaData(Map<String,?> metaData)	Sets the meta-data for this event.
EventSpecifierDsl	payload(Object payload)	Sets the event payload.
EventSpecifierDsl	subject(String subject)	Sets the subject for this specific event, overriding the value from GivenDsl.usingSubject(String).
EventSpecifierDsl	time(Instant time)	Sets the timestamp for this specific event, overriding the value from GivenDsl.time(Instant).

Method Details

payload

EventSpecifierDsl payload(Object payload)

Sets the event payload. This is the actual event object that will be passed to the StateRebuildingHandler.

This method must be called - an IllegalArgumentException is thrown if the event is used without specifying a payload.

Parameters:

payload - the event payload object

Returns:

this for method chaining

time

EventSpecifierDsl time(Instant time)

Sets the timestamp for this specific event, overriding the value from GivenDsl.time(Instant). This timestamp is available in StateRebuildingHandler.FromObjectAndRawEvent via the raw event's time() method.

Parameters:

time - the timestamp for this event

Returns:

this for method chaining

subject

EventSpecifierDsl subject(String subject)

Sets the subject for this specific event, overriding the value from GivenDsl.usingSubject(String). This subject is applied as the raw event's subject.

Parameters:

subject - the subject for this event, or null to use the default

Returns:

this for method chaining

id

EventSpecifierDsl id(String id)

Sets the unique identifier for this event. If not specified, a random UUID is generated. This id is available in StateRebuildingHandler.FromObjectAndRawEvent via the raw event's id() method.

Parameters:

id - the unique identifier for this event

Returns:

this for method chaining

metaData

EventSpecifierDsl metaData(Map<String,?> metaData)

Sets the meta-data for this event. Meta-data is available in StateRebuildingHandler.FromObjectAndMetaDataAndSubjectAndRawEvent.

If not specified, an empty map is used.

Parameters:

metaData - the meta-data map for this event

Returns:

this for method chaining