Package org.springframework.modulith.events.core

Interface TargetEventPublication

All Superinterfaces:

Completable, EventPublication

All Known Implementing Classes:

DefaultEventPublication

public interface TargetEventPublication
extends Completable, EventPublication

An event publication.

Author:

Oliver Drotbohm, Björn Kieling, Dmitry Belyaev

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.modulith.events.EventPublication

EventPublication.Status

Method Summary

Modifier and Type	Method	Description
PublicationTargetIdentifier	getTargetIdentifier()	Returns the identifier of the target that the event is supposed to be published to.
default boolean	isAssociatedWith(Object event, PublicationTargetIdentifier identifier)	Returns whether the TargetEventPublication is associated with the given event instance and PublicationTargetIdentifier.
default boolean	isIdentifiedBy(PublicationTargetIdentifier identifier)	Returns whether the publication is identified by the given PublicationTargetIdentifier.
static TargetEventPublication	of(Object event, PublicationTargetIdentifier id)	Creates a TargetEventPublication for the given event an listener identifier using a default Instant.
static TargetEventPublication	of(Object event, PublicationTargetIdentifier id, Instant publicationDate)	Creates a TargetEventPublication for the given event an listener identifier and publication date.

Methods inherited from interface org.springframework.modulith.events.core.Completable

markCompleted

Methods inherited from interface org.springframework.modulith.events.EventPublication

compareTo, getApplicationEvent, getCompletionAttempts, getCompletionDate, getEvent, getIdentifier, getLastResubmissionDate, getPublicationDate, getStatus, isCompleted, isPublicationCompleted

Method Details

of

static TargetEventPublication of(Object event,
 PublicationTargetIdentifier id)

Creates a TargetEventPublication for the given event an listener identifier using a default Instant. Prefer using of(Object, PublicationTargetIdentifier, Instant) with a dedicated Instant obtained from a Clock.

Parameters:

event - must not be null.

id - must not be null.

Returns:

will never be null.

See Also:

• of(Object, PublicationTargetIdentifier, Instant)

of

static TargetEventPublication of(Object event,
 PublicationTargetIdentifier id,
 Instant publicationDate)

Creates a TargetEventPublication for the given event an listener identifier and publication date.

Parameters:

event - must not be null.

id - must not be null.

publicationDate - must not be null.

Returns:

will never be null.

getTargetIdentifier

PublicationTargetIdentifier getTargetIdentifier()

Returns the identifier of the target that the event is supposed to be published to.

Returns:

isIdentifiedBy

default boolean isIdentifiedBy(PublicationTargetIdentifier identifier)

Returns whether the publication is identified by the given PublicationTargetIdentifier.

Parameters:

identifier - must not be null.

isAssociatedWith

default boolean isAssociatedWith(Object event,
 PublicationTargetIdentifier identifier)

Returns whether the TargetEventPublication is associated with the given event instance and PublicationTargetIdentifier.

Parameters:

event - must not be null.

identifier - must not be null.

Since:

1.3