[jOOQ/jOOQ#8815] Add missing Javadoc to

Configuration.visitListenerProviders()
This commit is contained in:
Lukas Eder 2019-06-19 11:09:48 +02:00
parent 5aee8a9b5d
commit d53dee0696

View File

@ -376,7 +376,27 @@ public interface Configuration extends Serializable {
ExecuteListenerProvider[] executeListenerProviders();
/**
* TODO [#2667]
* Get the configured <code>VisitListenerProvider</code> instances from this
* configuration.
* <p>
* This method allows for retrieving the configured
* <code>VisitListenerProvider</code> instances from this configuration. The
* providers will provide jOOQ with {@link VisitListener} instances. These
* instances receive query rendering lifecycle notification events every
* time jOOQ renders queries. jOOQ makes no assumptions about the internal
* state of these listeners, i.e. listener instances may
* <ul>
* <li>share this <code>Configuration</code>'s lifecycle (i.e. that of a
* JDBC <code>Connection</code>, or that of a transaction)</li>
* <li>share the lifecycle of an <code>ExecuteContext</code> (i.e. that of a
* single query execution)</li>
* <li>follow an entirely different lifecycle.</li>
* </ul>
*
* @return The configured set of visit listeners.
* @see VisitListenerProvider
* @see VisitListener
* @see VisitContext
*/
VisitListenerProvider[] visitListenerProviders();