From 5fee34d82a125bfae7fcc51f86312db3058bdcde Mon Sep 17 00:00:00 2001 From: lukaseder Date: Mon, 15 May 2017 15:12:29 +0200 Subject: [PATCH] [#6217] Add more details to QueryPart.toString() Javadoc --- jOOQ/src/main/java/org/jooq/QueryPart.java | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/jOOQ/src/main/java/org/jooq/QueryPart.java b/jOOQ/src/main/java/org/jooq/QueryPart.java index 2658f70df9..6977a373b9 100644 --- a/jOOQ/src/main/java/org/jooq/QueryPart.java +++ b/jOOQ/src/main/java/org/jooq/QueryPart.java @@ -36,6 +36,8 @@ package org.jooq; import java.io.Serializable; +import org.jooq.conf.Settings; + /** * The common base type for all objects that can be used for query composition. *

@@ -47,13 +49,20 @@ import java.io.Serializable; public interface QueryPart extends Serializable { /** - * Render a SQL string of this QueryPart + * Render a SQL string representation of this QueryPart. *

* For improved debugging, this renders a SQL string of this - * QueryPart with inlined bind variables. If you wish to gain - * more control over the concrete SQL rendering of this - * QueryPart, use {@link DSLContext#renderContext()} to obtain a - * configurable render context for SQL rendering. + * QueryPart with inlined bind variables. If this + * QueryPart is {@link Attachable}, then the attached + * {@link Configuration} may be used for rendering the SQL string, including + * {@link SQLDialect} and {@link Settings}. Do note that most + * QueryPart instances are not attached to a + * {@link Configuration}, and thus there is no guarantee that the SQL string + * will make sense in the context of a specific database. + *

+ * If you wish to gain more control over the concrete SQL rendering of this + * QueryPart, use {@link DSLContext#renderContext()} to obtain + * a configurable render context for SQL rendering. * * @return A SQL string representation of this QueryPart */