From 15e9308729b8d7f17b8be0bb186c6baa12fbf088 Mon Sep 17 00:00:00 2001 From: Lukas Eder Date: Tue, 3 Dec 2019 15:01:14 +0100 Subject: [PATCH] [jOOQ/jOOQ#9613] Update Configuration Javadoc --- .../src/main/java/org/jooq/Configuration.java | 65 ++++++++++++------- 1 file changed, 41 insertions(+), 24 deletions(-) diff --git a/jOOQ/src/main/java/org/jooq/Configuration.java b/jOOQ/src/main/java/org/jooq/Configuration.java index 7c5e98696b..5c18dcf0a0 100644 --- a/jOOQ/src/main/java/org/jooq/Configuration.java +++ b/jOOQ/src/main/java/org/jooq/Configuration.java @@ -40,6 +40,7 @@ package org.jooq; import java.io.Serializable; import java.sql.Connection; import java.sql.Savepoint; +import java.sql.Wrapper; import java.time.Clock; import java.util.Map; import java.util.concurrent.Executor; @@ -94,8 +95,8 @@ import org.jooq.tools.StopWatchListener; *

Types composing its state:

* * - *
  • {@link #transactionProvider()}: The {@link TransactionProvider} that - * defines and implements the behaviour of the - * {@link DSLContext#transaction(TransactionalRunnable)} and - * {@link DSLContext#transactionResult(TransactionalCallable)} methods.
    + *
  • {@link #executeListenerProviders()}: A set of + * {@link ExecuteListenerProvider} that implement {@link Query} execution + * lifecycle management.
    *
    - * jOOQ-provided default implementations include: + * jOOQ-provided example implementations include: * *
  • + *
  • {@link #executorProvider()}: A provider for an {@link Executor}, which is + * used by default, in the absence of an explicit executor, to execute + * asynchronous logic throughout the jOOQ API, such as for example + * {@link ResultQuery#fetchAsync()}.
  • + *
  • {@link #metaProvider()}: A provider for the {@link DSLContext#meta()} + * object which is used to look up database meta data from various jOOQ APIs, + * such as for example the {@link DSLContext#parser()}.
  • + *
  • {@link #migrationListenerProviders()}: A set of + * {@link MigrationListenerProvider} that allow for listening to the database + * migration lifecycle.
  • + *
  • {@link #recordListenerProviders()}: A set of + * {@link RecordListenerProvider} that implement {@link Record} fetching and + * storing lifecycle management, specifically for use with + * {@link UpdatableRecord}.
    + *
    + * jOOQ does not provide any implementations.
  • *
  • {@link #recordMapperProvider()}: The {@link RecordMapperProvider} that * defines and implements the behaviour of {@link Record#into(Class)}, * {@link ResultQuery#fetchInto(Class)}, {@link Cursor#fetchInto(Class)}, and @@ -141,23 +158,23 @@ import org.jooq.tools.StopWatchListener; * use-cases.
  • * * - *
  • {@link #recordListenerProviders()}: A set of - * {@link RecordListenerProvider} that implement {@link Record} fetching and - * storing lifecycle management, specifically for use with - * {@link UpdatableRecord}.
    + *
  • {@link #recordUnmapperProvider()}: The inverse of the + * {@link #recordMapperProvider()} that allows to implement the behaviour of + * {@link Record#from(Object)}, and various related methods.
  • + *
  • {@link #transactionProvider()}: The {@link TransactionProvider} that + * defines and implements the behaviour of the + * {@link DSLContext#transaction(TransactionalRunnable)} and + * {@link DSLContext#transactionResult(TransactionalCallable)} methods.
    *
    - * jOOQ does not provide any implementations.
  • - *
  • {@link #executeListenerProviders()}: A set of - * {@link ExecuteListenerProvider} that implement {@link Query} execution - * lifecycle management.
    - *
    - * jOOQ-provided example implementations include: + * jOOQ-provided default implementations include: * + *
  • + *
  • {@link #unwrapperProvider()}: An {@link UnwrapperProvider} that allows + * for injecting custom JDBC {@link Wrapper#unwrap(Class)} behaviour.
  • *
  • {@link #visitListenerProviders()}: A set of {@link VisitListenerProvider} * that implement {@link Query} rendering and variable binding lifecycle * management, and that are allowed to implement query transformation - e.g. to