org.springframework.data.relational.core.mapping.event

Class RelationalEventWithId

java.lang.Object

java.util.EventObject

org.springframework.context.ApplicationEvent

org.springframework.data.relational.core.mapping.event.RelationalEventWithId

All Implemented Interfaces:

Serializable, RelationalEvent, WithId

Direct Known Subclasses:

AfterDeleteEvent, BeforeDeleteEvent, RelationalEventWithIdAndEntity

public class RelationalEventWithId
extends ApplicationEvent
implements WithId

A SimpleRelationalEvent guaranteed to have an identifier.

Author:

Jens Schauder

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
RelationalEventWithId(Identifier.Specified id, Optional<?> entity, AggregateChange change)

Method Summary

Modifier and Type	Method and Description
AggregateChange	getChange() Deprecated. There is currently no replacement for this. If something like this is required please create an issue outlining your use case.
Identifier.Specified	getId() Deprecated. since 1.1, obtain the id from the entity instead.
Optional<Object>	getOptionalEntity() Returns the aggregate root the event was triggered for.

Methods inherited from class org.springframework.context.ApplicationEvent

getTimestamp

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.springframework.data.relational.core.mapping.event.RelationalEvent

getOptionalEntity

Constructor Detail

RelationalEventWithId

public RelationalEventWithId(Identifier.Specified id,
                             Optional<?> entity,
                             @Nullable
                             AggregateChange change)

Method Detail

getId

@Deprecated
public Identifier.Specified getId()

Deprecated. since 1.1, obtain the id from the entity instead.

Events with an identifier will always return a Identifier.Specified one.

Specified by:

getId in interface RelationalEvent

Specified by:

getId in interface WithId

Returns:

the source of the event as an Identifier. Guaranteed to be not null.

getOptionalEntity

public Optional<Object> getOptionalEntity()

Description copied from interface: RelationalEvent

Returns the aggregate root the event was triggered for.

Specified by:

getOptionalEntity in interface RelationalEvent

Returns:

will never be null.

getChange

@Deprecated
public AggregateChange getChange()

Deprecated. There is currently no replacement for this. If something like this is required please create an issue outlining your use case.

Returns the an AggregateChange instance representing the SQL statements performed by the action that triggered this event.

Returns:

Guaranteed to be not null.