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

Added remarks about VisitListener being experimental

Browse Source
This commit is contained in:
Lukas Eder 2013-10-08 13:56:49 +02:00
parent 2918b30ed2
commit 5fdca06dd1
2 changed files with 43 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
jOOQ/src/main/java/org/jooq/Clause.java
View File

@ -40,8 +40,11 @@
*/
package org.jooq;
/**
* A listing of clauses that emit events {@link VisitListener}.
/**
* A listing of clauses that emit events {@link VisitListener}.
* <p>
* <h3>Disclaimer</h3> This SPI is still <strong>experimental</strong>! Some SPI
* elements and/or behavioural elements may change in future minor releases.
*/
public enum Clause {

73
jOOQ/src/main/java/org/jooq/VisitListener.java
View File

@ -40,33 +40,33 @@
*/
package org.jooq;
import java.sql.PreparedStatement;
import java.util.EventListener;
import java.sql.PreparedStatement;
import java.util.EventListener;
/**
* A listener for {@link QueryPart} traversal events.
* <p>
* Users may want to centrally inject custom behaviour when rendering their
* {@link QueryPart} objects or when binding values to {@link PreparedStatement}
* s. This service provider allows to hook in callback method implementations
* before or after these events:
* <ul>
* <li>The visit of a {@link Clause}</li>
* <li>The visit of a {@link QueryPart}</li>
* </ul>
* <p>
* The following rules apply to visiting clauses and query parts:
* <ul>
* <li>Clauses may "surround" a query part. See an example below.</li>
* <li>Not every query part is "surrounded" by a clause</li>
* </ul>
* <p>
* An example is given here:
* <code><pre>SELECT 1 FROM [A CROSS JOIN B]</pre></code>
* <p>
* The above example will create the following set of events:
*
* <pre>
/**
* A listener for {@link QueryPart} traversal events.
* <p>
* Users may want to centrally inject custom behaviour when rendering their
* {@link QueryPart} objects or when binding values to {@link PreparedStatement}
* s. This service provider allows to hook in callback method implementations
* before or after these events:
* <ul>
* <li>The visit of a {@link Clause}</li>
* <li>The visit of a {@link QueryPart}</li>
* </ul>
* <p>
* The following rules apply to visiting clauses and query parts:
* <ul>
* <li>Clauses may "surround" a query part. See an example below.</li>
* <li>Not every query part is "surrounded" by a clause</li>
* </ul>
* <p>
* An example is given here:
* <code><pre>SELECT 1 FROM [A CROSS JOIN B]</pre></code>
* <p>
* The above example will create the following set of events:
*
* <pre>
* {@link Clause#SELECT}
* +-{@link Clause#SELECT_SELECT}
* | +-{@link Clause#FIELD}
@ -77,15 +77,18 @@ import java.util.EventListener;
* | +-table("A")
* +-{@link Clause#TABLE_JOIN_CROSS}
* +-{@link Clause#TABLE}
* +-table("B")
* </pre>
* <p>
* Whatever is not a {@link Clause} in the above example is a {@link QueryPart}.
* <p>
* Note: [#2694] [#2695] As of jOOQ 3.2, {@link VisitListener} receive events
* only in the context of a {@link RenderContext}, not of a {@link BindContext}.
*
* @author Lukas Eder
* +-table("B")
* </pre>
* <p>
* Whatever is not a {@link Clause} in the above example is a {@link QueryPart}.
* <p>
* Note: [#2694] [#2695] As of jOOQ 3.2, {@link VisitListener} receive events
* only in the context of a {@link RenderContext}, not of a {@link BindContext}.
* <p>
* <h3>Disclaimer</h3> This SPI is still <strong>experimental</strong>! Some SPI
* elements and/or behavioural elements may change in future minor releases.
*
* @author Lukas Eder
*/
public interface VisitListener extends EventListener {