Package org.springframework.modulith.events.core

Interface EventPublication

All Superinterfaces:

Comparable<EventPublication>, Completable

All Known Implementing Classes:

DefaultEventPublication

public interface EventPublication
extends Comparable<EventPublication>, Completable

An event publication.

Author:

Oliver Drotbohm, Björn Kieling, Dmitry Belyaev

Method Summary

Modifier and Type	Method	Description
default int	compareTo(EventPublication that)
default ApplicationEvent	getApplicationEvent()	Returns the event as Spring ApplicationEvent, effectively wrapping it into a PayloadApplicationEvent in case it's not one already.
Optional<Instant>	getCompletionDate()	Returns the completion date of the publication.
Object	getEvent()	Returns the event that is published.
UUID	getIdentifier()	Returns a unique identifier for this publication.
Instant	getPublicationDate()	Returns the time the event is published at.
PublicationTargetIdentifier	getTargetIdentifier()	Returns the identifier of the target that the event is supposed to be published to.
default boolean	isIdentifiedBy(PublicationTargetIdentifier identifier)	Returns whether the publication is identified by the given PublicationTargetIdentifier.
default boolean	isPublicationCompleted()	Returns whether the publication of the event has completed.
static EventPublication	of(Object event, PublicationTargetIdentifier id)	Creates a EventPublication for the given event an listener identifier using a default Instant.
static EventPublication	of(Object event, PublicationTargetIdentifier id, Instant publicationDate)	Creates a EventPublication for the given event an listener identifier and publication date.

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

markCompleted

Method Details

of

static EventPublication of(Object event,
 PublicationTargetIdentifier id)

Creates a EventPublication 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 EventPublication of(Object event,
 PublicationTargetIdentifier id,
 Instant publicationDate)

Creates a EventPublication 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.

getIdentifier

UUID getIdentifier()

Returns a unique identifier for this publication.

Returns:

will never be null.

getEvent

Object getEvent()

Returns the event that is published.

Returns:

getApplicationEvent

default ApplicationEvent getApplicationEvent()

Returns the event as Spring ApplicationEvent, effectively wrapping it into a PayloadApplicationEvent in case it's not one already.

Returns:

getPublicationDate

Instant getPublicationDate()

Returns the time the event is published at.

Returns:

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.

Returns:

getCompletionDate

Optional<Instant> getCompletionDate()

Returns the completion date of the publication.

Returns:

will never be null.

isPublicationCompleted

default boolean isPublicationCompleted()

Returns whether the publication of the event has completed.

Returns:

will never be null.

compareTo

default int compareTo(EventPublication that)

Specified by:

compareTo in interface Comparable<EventPublication>