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
void	deleteEnd(RecordContext ctx)	Called after deleting an UpdatableRecord.
void	deleteStart(RecordContext ctx)	Called before deleting an UpdatableRecord.
void	exception(RecordContext ctx)	Called when an exception occurs.
void	insertEnd(RecordContext ctx)	Called after inserting an UpdatableRecord.
void	insertStart(RecordContext ctx)	Called before inserting an UpdatableRecord.
void	loadEnd(RecordContext ctx)	Called after loading an UpdatableRecord.
void	loadStart(RecordContext ctx)	Called before loading an UpdatableRecord.
void	mergeEnd(RecordContext ctx)	Called after merging an UpdatableRecord.
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.
void	refreshEnd(RecordContext ctx)	Called after refreshing an UpdatableRecord.
void	refreshStart(RecordContext ctx)	Called before refreshing an UpdatableRecord.
void	storeEnd(RecordContext ctx)	Called after storing an UpdatableRecord.
void	storeStart(RecordContext ctx)	Called before storing an UpdatableRecord.
void	updateEnd(RecordContext ctx)	Called after updating an UpdatableRecord.
void	updateStart(RecordContext ctx)	Called before updating an UpdatableRecord.

Method Details

storeStart

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.

See Also:

• UpdatableRecord.store()

storeEnd

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.

See Also:

• UpdatableRecord.store()

insertStart

void insertStart(RecordContext ctx)

Called before inserting an UpdatableRecord.

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

See Also:

• UpdatableRecord.insert()

insertEnd

void insertEnd(RecordContext ctx)

Called after inserting an UpdatableRecord.

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

See Also:

• UpdatableRecord.insert()

updateStart

void updateStart(RecordContext ctx)

Called before updating an UpdatableRecord.

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

See Also:

• UpdatableRecord.update()

updateEnd

void updateEnd(RecordContext ctx)

Called after updating an UpdatableRecord.

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

See Also:

• UpdatableRecord.update()

mergeStart

void mergeStart(RecordContext ctx)

Called before merging an UpdatableRecord.

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

See Also:

• UpdatableRecord.merge()

mergeEnd

void mergeEnd(RecordContext ctx)

Called after merging an UpdatableRecord.

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

See Also:

• UpdatableRecord.merge()

deleteStart

void deleteStart(RecordContext ctx)

Called before deleting an UpdatableRecord.

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

See Also:

• UpdatableRecord.delete()

deleteEnd

void deleteEnd(RecordContext ctx)

Called after deleting an UpdatableRecord.

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

See Also:

• UpdatableRecord.delete()

loadStart

void loadStart(RecordContext ctx)

Called before loading an UpdatableRecord.

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

loadEnd

void loadEnd(RecordContext ctx)

Called after loading an UpdatableRecord.

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

refreshStart

void refreshStart(RecordContext ctx)

Called before refreshing an UpdatableRecord.

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

See Also:

• UpdatableRecord.refresh()

refreshEnd

void refreshEnd(RecordContext ctx)

Called after refreshing an UpdatableRecord.

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

See Also:

• UpdatableRecord.refresh()

exception

void exception(RecordContext ctx)

Called when an exception occurs.

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.