Package io.micronaut.data.runtime.event.listeners

Class VersionGeneratingEntityEventListener

java.lang.Object

io.micronaut.data.runtime.event.listeners.VersionGeneratingEntityEventListener

All Implemented Interfaces:

io.micronaut.core.order.Ordered, EntityEventListener<Object>, PropertyAutoPopulator<Version>, EventListener

@Singleton
public class VersionGeneratingEntityEventListener
extends Object
implements EntityEventListener<Object>, PropertyAutoPopulator<Version>

Supports optimistic locking by using a version.

Since:

2.4.0

Author:

Denis Stepanov

Field Summary

Fields inherited from interface io.micronaut.data.event.EntityEventListener

NOOP

Fields inherited from interface io.micronaut.core.order.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
VersionGeneratingEntityEventListener(DateTimeProvider dateTimeProvider, DataConversionService conversionService)

Method Summary

Modifier and Type	Method	Description
@NonNull Object	populate(RuntimePersistentProperty<?> property, @Nullable Object previousValue)	Auto-populating the property.
boolean	prePersist(@NonNull EntityEventContext<Object> context)	A pre-persist hook.
boolean	preRemove(@NonNull EntityEventContext<Object> context)	A pre-remove hook.
boolean	preUpdate(@NonNull EntityEventContext<Object> context)	A pre-update hook.
boolean	supports(RuntimePersistentEntity<Object> entity, Class<? extends Annotation> eventType)	Allows including or excluding a listener for a specific entity.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.data.event.EntityEventListener

postLoad, postPersist, postRemove, postUpdate, preQuery

Methods inherited from interface io.micronaut.core.order.Ordered

getOrder

Constructor Details

VersionGeneratingEntityEventListener

public VersionGeneratingEntityEventListener(DateTimeProvider dateTimeProvider,
 DataConversionService conversionService)

Method Details

supports

public boolean supports(RuntimePersistentEntity<Object> entity,
 Class<? extends Annotation> eventType)

Description copied from interface: EntityEventListener

Allows including or excluding a listener for a specific entity.

Specified by:

supports in interface EntityEventListener<Object>

Parameters:

entity - The entity

eventType - The event type

Returns:

True if it is supported

prePersist

public boolean prePersist(@NonNull
 @NonNull EntityEventContext<Object> context)

Description copied from interface: EntityEventListener

A pre-persist hook. Implementors can return false to evict the operation.

Specified by:

prePersist in interface EntityEventListener<Object>

Parameters:

context - The context object

Returns:

A boolean value indicating whether to proceed with the operation.

preUpdate

public boolean preUpdate(@NonNull
 @NonNull EntityEventContext<Object> context)

Description copied from interface: EntityEventListener

A pre-update hook. Implementors can return false to evict the operation.

Specified by:

preUpdate in interface EntityEventListener<Object>

Parameters:

context - The context object

Returns:

A boolean value indicating whether to proceed with the operation.

preRemove

public boolean preRemove(@NonNull
 @NonNull EntityEventContext<Object> context)

Description copied from interface: EntityEventListener

A pre-remove hook. Implementors can return false to evict the operation.

Specified by:

preRemove in interface EntityEventListener<Object>

Parameters:

context - The context object

Returns:

A boolean value indicating whether to proceed with the operation.

populate

@NonNull
public @NonNull Object populate(RuntimePersistentProperty<?> property,
 @Nullable
 @Nullable Object previousValue)

Description copied from interface: PropertyAutoPopulator

Auto-populating the property.

Specified by:

populate in interface PropertyAutoPopulator<Version>

Parameters:

property - the property to auto-populate

previousValue - the previous value, if any

Returns:

new value