Package org.springframework.modulith.events

Interface EventPublication

All Superinterfaces:

Comparable<EventPublication>

All Known Subinterfaces:

CompletableEventPublication

All Known Implementing Classes:

DefaultEventPublication

public interface EventPublication
extends Comparable<EventPublication>

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.
Object	getEvent()	Returns the event that is published.
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.

Method Details

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:

compareTo

default int compareTo(EventPublication that)

Specified by:

compareTo in interface Comparable<EventPublication>