github/jooq
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[jOOQ/jOOQ#8797] Improve StopWatchListener Javadoc

Browse Source 
Add Javadoc to StopWatchListener explaining that it should be wrapped in an ExecuteListenerProvider
This commit is contained in:
Lukas Eder 2019-06-13 17:37:44 +02:00
parent 01dec5cadf
commit 384b5ec325
1 changed files with 17 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
jOOQ/src/main/java/org/jooq/tools/StopWatchListener.java
View File

@ -39,10 +39,26 @@ package org.jooq.tools;
import org.jooq.ExecuteContext;
import org.jooq.ExecuteListener;
import org.jooq.ExecuteListenerProvider;
/**
* A default {@link ExecuteListener} that just logs events to java.util.logging,
* log4j, or slf4j using the {@link JooqLogger}
* log4j, or slf4j using the {@link JooqLogger}.
* <p>
* This is a stateful listener, meaning it has a reference to a
* {@link StopWatch} that is shared among all query executions that use this
* same {@link StopWatchListener}. If the instance is shared among query
* executions, the listener measures the time passed since the first
* initialisation. In order to let it measure the time for each individual query
* execution afresh, use an {@link ExecuteListenerProvider} to create new
* instances every time:
* <p>
*
* <pre>
* <code>
* configuration.set(StopWatchListener::new)
* </code>
* </pre>
*
* @author Lukas Eder
*/