Module org.jooq

Package org.jooq

Interface RecordListener

All Superinterfaces:

EventListener

All Known Implementing Classes:

CallbackRecordListener, DefaultRecordListener

public interface RecordListener
extends EventListener

A listener for manipulation events on UpdatableRecords.

Users may want to centrally inject custom behaviour when manipulating their UpdatableRecord objects, performing CRUD. This service provider allows to hook in callback method implementations for before or after any of these methods:

• UpdatableRecord.store()
• UpdatableRecord.insert()
• UpdatableRecord.update()
• UpdatableRecord.delete()
• UpdatableRecord.refresh()

A RecordListener does not act as a client-side trigger. As such, it does not affect any bulk DML statements (e.g. a DSLContext.update(Table)), whose affected records are not available to clients. For those purposes, use a server-side trigger DSLContext.createTrigger(Name) if records should be changed, or a VisitListener if the SQL query should be changed, independently of data.

Author:

Lukas Eder

Method Summary

Modifier and Type	Method	Description
default void	deleteEnd(RecordContext ctx)	Called after deleting an UpdatableRecord.
default void	deleteStart(RecordContext ctx)	Called before deleting an UpdatableRecord.
default void	exception(RecordContext ctx)	Called when an exception occurs.
default void	insertEnd(RecordContext ctx)	Called after inserting an UpdatableRecord.
default void	insertStart(RecordContext ctx)	Called before inserting an UpdatableRecord.
default void	loadEnd(RecordContext ctx)	Called after loading an UpdatableRecord.
default void	loadStart(RecordContext ctx)	Called before loading an UpdatableRecord.
default void	mergeEnd(RecordContext ctx)	Called after merging an UpdatableRecord.
default void	mergeStart(RecordContext ctx)	Called before merging an UpdatableRecord.
static CallbackRecordListener	onDeleteEnd(Consumer<? super RecordContext> onDeleteEnd)	Create a RecordListener with a onDeleteEnd(Consumer) implementation.
static CallbackRecordListener	onDeleteStart(Consumer<? super RecordContext> onDeleteStart)	Create a RecordListener with a onDeleteStart(Consumer) implementation.
static CallbackRecordListener	onException(Consumer<? super RecordContext> onException)	Create a RecordListener with a onException(Consumer) implementation.
static CallbackRecordListener	onInsertEnd(Consumer<? super RecordContext> onInsertEnd)	Create a RecordListener with a onInsertEnd(Consumer) implementation.
static CallbackRecordListener	onInsertStart(Consumer<? super RecordContext> onInsertStart)	Create a RecordListener with a onInsertStart(Consumer) implementation.
static CallbackRecordListener	onLoadEnd(Consumer<? super RecordContext> onLoadEnd)	Create a RecordListener with a onLoadEnd(Consumer) implementation.
static CallbackRecordListener	onLoadStart(Consumer<? super RecordContext> onLoadStart)	Create a RecordListener with a onLoadStart(Consumer) implementation.
static CallbackRecordListener	onMergeEnd(Consumer<? super RecordContext> onMergeEnd)	Create a RecordListener with a onMergeEnd(Consumer) implementation.
static CallbackRecordListener	onMergeStart(Consumer<? super RecordContext> onMergeStart)	Create a RecordListener with a onMergeStart(Consumer) implementation.
static CallbackRecordListener	onRefreshEnd(Consumer<? super RecordContext> onRefreshEnd)	Create a RecordListener with a onRefreshEnd(Consumer) implementation.
static CallbackRecordListener	onRefreshStart(Consumer<? super RecordContext> onRefreshStart)	Create a RecordListener with a onRefreshStart(Consumer) implementation.
static CallbackRecordListener	onStoreEnd(Consumer<? super RecordContext> onStoreEnd)	Create a RecordListener with a onStoreEnd(Consumer) implementation.
static CallbackRecordListener	onStoreStart(Consumer<? super RecordContext> onStoreStart)	Create a RecordListener with a onStoreStart(Consumer) implementation.
static CallbackRecordListener	onUpdateEnd(Consumer<? super RecordContext> onUpdateEnd)	Create a RecordListener with a onUpdateEnd(Consumer) implementation.
static CallbackRecordListener	onUpdateStart(Consumer<? super RecordContext> onUpdateStart)	Create a RecordListener with a onUpdateStart(Consumer) implementation.
default void	refreshEnd(RecordContext ctx)	Called after refreshing an UpdatableRecord.
default void	refreshStart(RecordContext ctx)	Called before refreshing an UpdatableRecord.
default void	storeEnd(RecordContext ctx)	Called after storing an UpdatableRecord.
default void	storeStart(RecordContext ctx)	Called before storing an UpdatableRecord.
default void	updateEnd(RecordContext ctx)	Called after updating an UpdatableRecord.
default void	updateStart(RecordContext ctx)	Called before updating an UpdatableRecord.

Method Details

storeStart

default void storeStart(RecordContext ctx)

Called before storing an UpdatableRecord.

Implementations are allowed to modify RecordContext.record() prior to storing. Note that modifying the record's primary key value may influence whether storing results in an INSERT or UPDATE statement.

A store event will generate a nested insertStart(RecordContext) or updateStart(RecordContext) event.

Parameters:

ctx - The context containing information about the record operation.

See Also:

• UpdatableRecord.store()

storeEnd

default void storeEnd(RecordContext ctx)

Called after storing an UpdatableRecord.

Implementations are allowed to modify RecordContext.record() after storing. Note that modifying the record's primary key value may influence whether storing results in an INSERT or UPDATE statement.

A store event will generate a nested insertEnd(RecordContext) or updateEnd(RecordContext) event.

Parameters:

ctx - The context containing information about the record operation.

See Also:

• UpdatableRecord.store()

insertStart

default void insertStart(RecordContext ctx)

Called before inserting an UpdatableRecord.

Implementations are allowed to modify RecordContext.record() prior to inserting.

Parameters:

ctx - The context containing information about the record operation.

See Also:

• UpdatableRecord.insert()

insertEnd

default void insertEnd(RecordContext ctx)

Called after inserting an UpdatableRecord.

Implementations are allowed to modify RecordContext.record() after inserting.

Parameters:

ctx - The context containing information about the record operation.

See Also:

• UpdatableRecord.insert()

updateStart

default void updateStart(RecordContext ctx)

Called before updating an UpdatableRecord.

Implementations are allowed to modify RecordContext.record() prior to updating.

Parameters:

ctx - The context containing information about the record operation.

See Also:

• UpdatableRecord.update()

updateEnd

default void updateEnd(RecordContext ctx)

Called after updating an UpdatableRecord.

Implementations are allowed to modify RecordContext.record() after updating.

Parameters:

ctx - The context containing information about the record operation.

See Also:

• UpdatableRecord.update()

mergeStart

default void mergeStart(RecordContext ctx)

Called before merging an UpdatableRecord.

Implementations are allowed to modify RecordContext.record() prior to merging.

Parameters:

ctx - The context containing information about the record operation.

See Also:

• UpdatableRecord.merge()

mergeEnd

default void mergeEnd(RecordContext ctx)

Called after merging an UpdatableRecord.

Implementations are allowed to modify RecordContext.record() after merging.

Parameters:

ctx - The context containing information about the record operation.

See Also:

• UpdatableRecord.merge()

deleteStart

default void deleteStart(RecordContext ctx)

Called before deleting an UpdatableRecord.

Implementations are allowed to modify RecordContext.record() prior to deleting.

Parameters:

ctx - The context containing information about the record operation.

See Also:

• UpdatableRecord.delete()

deleteEnd

default void deleteEnd(RecordContext ctx)

Called after deleting an UpdatableRecord.

Implementations are allowed to modify RecordContext.record() after deleting.

Parameters:

ctx - The context containing information about the record operation.

See Also:

• UpdatableRecord.delete()

loadStart

default void loadStart(RecordContext ctx)

Called before loading an UpdatableRecord.

Implementations are allowed to modify RecordContext.record() prior to loading.

Parameters:

ctx - The context containing information about the record operation.

loadEnd

default void loadEnd(RecordContext ctx)

Called after loading an UpdatableRecord.

Implementations are allowed to modify RecordContext.record() after loading.

Parameters:

ctx - The context containing information about the record operation.

refreshStart

default void refreshStart(RecordContext ctx)

Called before refreshing an UpdatableRecord.

Implementations are allowed to modify RecordContext.record() prior to refreshing.

Parameters:

ctx - The context containing information about the record operation.

See Also:

• UpdatableRecord.refresh()

refreshEnd

default void refreshEnd(RecordContext ctx)

Called after refreshing an UpdatableRecord.

Implementations are allowed to modify RecordContext.record() after refreshing.

Parameters:

ctx - The context containing information about the record operation.

See Also:

• UpdatableRecord.refresh()

exception

default void exception(RecordContext ctx)

Called when an exception occurs.

Parameters:

ctx - The context containing information about the record operation.

onStoreStart

static CallbackRecordListener onStoreStart(Consumer<? super RecordContext> onStoreStart)

Create a RecordListener with a onStoreStart(Consumer) implementation.

onStoreEnd

static CallbackRecordListener onStoreEnd(Consumer<? super RecordContext> onStoreEnd)

Create a RecordListener with a onStoreEnd(Consumer) implementation.

onInsertStart

static CallbackRecordListener onInsertStart(Consumer<? super RecordContext> onInsertStart)

Create a RecordListener with a onInsertStart(Consumer) implementation.

onInsertEnd

static CallbackRecordListener onInsertEnd(Consumer<? super RecordContext> onInsertEnd)

Create a RecordListener with a onInsertEnd(Consumer) implementation.

onUpdateStart

static CallbackRecordListener onUpdateStart(Consumer<? super RecordContext> onUpdateStart)

Create a RecordListener with a onUpdateStart(Consumer) implementation.

onUpdateEnd

static CallbackRecordListener onUpdateEnd(Consumer<? super RecordContext> onUpdateEnd)

Create a RecordListener with a onUpdateEnd(Consumer) implementation.

onMergeStart

static CallbackRecordListener onMergeStart(Consumer<? super RecordContext> onMergeStart)

Create a RecordListener with a onMergeStart(Consumer) implementation.

onMergeEnd

static CallbackRecordListener onMergeEnd(Consumer<? super RecordContext> onMergeEnd)

Create a RecordListener with a onMergeEnd(Consumer) implementation.

onDeleteStart

static CallbackRecordListener onDeleteStart(Consumer<? super RecordContext> onDeleteStart)

Create a RecordListener with a onDeleteStart(Consumer) implementation.

onDeleteEnd

static CallbackRecordListener onDeleteEnd(Consumer<? super RecordContext> onDeleteEnd)

Create a RecordListener with a onDeleteEnd(Consumer) implementation.

onLoadStart

static CallbackRecordListener onLoadStart(Consumer<? super RecordContext> onLoadStart)

Create a RecordListener with a onLoadStart(Consumer) implementation.

onLoadEnd

static CallbackRecordListener onLoadEnd(Consumer<? super RecordContext> onLoadEnd)

Create a RecordListener with a onLoadEnd(Consumer) implementation.

onRefreshStart

static CallbackRecordListener onRefreshStart(Consumer<? super RecordContext> onRefreshStart)

Create a RecordListener with a onRefreshStart(Consumer) implementation.

onRefreshEnd

static CallbackRecordListener onRefreshEnd(Consumer<? super RecordContext> onRefreshEnd)

Create a RecordListener with a onRefreshEnd(Consumer) implementation.

onException

static CallbackRecordListener onException(Consumer<? super RecordContext> onException)

Create a RecordListener with a onException(Consumer) implementation.