From 46f5d7c0e6e9c2ca001c10ed780b4ea9e720e96d Mon Sep 17 00:00:00 2001 From: Lukas Eder Date: Wed, 28 Nov 2012 19:57:06 +0100 Subject: [PATCH] [#1983] Improve the Javadoc on Table.as() and Field.as() to hint at case-sensitivity and RenderNameStyle --- jOOQ/src/main/java/org/jooq/Field.java | 5 +++++ jOOQ/src/main/java/org/jooq/FieldLike.java | 6 ++++++ jOOQ/src/main/java/org/jooq/Table.java | 5 +++++ jOOQ/src/main/java/org/jooq/TableLike.java | 6 ++++++ 4 files changed, 22 insertions(+) diff --git a/jOOQ/src/main/java/org/jooq/Field.java b/jOOQ/src/main/java/org/jooq/Field.java index 62a67d4b40..64283fb4ee 100644 --- a/jOOQ/src/main/java/org/jooq/Field.java +++ b/jOOQ/src/main/java/org/jooq/Field.java @@ -55,6 +55,7 @@ import java.math.BigDecimal; import java.util.Collection; import java.util.Map; +import org.jooq.conf.Settings; import org.jooq.impl.Executor; import org.jooq.impl.Factory; import org.jooq.types.Interval; @@ -106,6 +107,10 @@ public interface Field extends GroupField { /** * Create an alias for this field + *

+ * Note that the case-sensitivity of the returned field depends on + * {@link Settings#getRenderNameStyle()}. By default, field aliases are + * quoted, and thus case-sensitive! * * @param alias The alias name * @return The field alias diff --git a/jOOQ/src/main/java/org/jooq/FieldLike.java b/jOOQ/src/main/java/org/jooq/FieldLike.java index e182571de3..c6da3f6e93 100644 --- a/jOOQ/src/main/java/org/jooq/FieldLike.java +++ b/jOOQ/src/main/java/org/jooq/FieldLike.java @@ -35,6 +35,8 @@ */ package org.jooq; +import org.jooq.conf.Settings; + /** * An object that can behave like a field (a field-like object) * @@ -57,6 +59,10 @@ public interface FieldLike { *

* This method is useful for things like * SELECT y.*, (SELECT a FROM x) [alias] FROM y + *

+ * Note that the case-sensitivity of the returned field depends on + * {@link Settings#getRenderNameStyle()}. By default, field aliases are + * quoted, and thus case-sensitive! * * @return This result provider as a Field<?> object */ diff --git a/jOOQ/src/main/java/org/jooq/Table.java b/jOOQ/src/main/java/org/jooq/Table.java index 6f24c4d46b..c0267a778e 100644 --- a/jOOQ/src/main/java/org/jooq/Table.java +++ b/jOOQ/src/main/java/org/jooq/Table.java @@ -53,6 +53,7 @@ import static org.jooq.SQLDialect.SYBASE; import java.util.Collection; import java.util.List; +import org.jooq.conf.Settings; import org.jooq.impl.Factory; /** @@ -80,6 +81,10 @@ public interface Table extends FieldProvider, TableLike { /** * Create an alias for this table + *

+ * Note that the case-sensitivity of the returned table depends on + * {@link Settings#getRenderNameStyle()}. By default, table aliases are + * quoted, and thus case-sensitive! * * @param alias The alias name * @return The table alias diff --git a/jOOQ/src/main/java/org/jooq/TableLike.java b/jOOQ/src/main/java/org/jooq/TableLike.java index a9670c74e4..98aabbd920 100644 --- a/jOOQ/src/main/java/org/jooq/TableLike.java +++ b/jOOQ/src/main/java/org/jooq/TableLike.java @@ -35,6 +35,8 @@ */ package org.jooq; +import org.jooq.conf.Settings; + /** * An object that can behave like a table (a table-like object) * @@ -56,6 +58,10 @@ public interface TableLike extends QueryPart { *

* This method is useful for things like * SELECT * FROM (SELECT * FROM x WHERE x.a = '1') [alias] WHERE ... + *

+ * Note that the case-sensitivity of the returned table depends on + * {@link Settings#getRenderNameStyle()}. By default, table aliases are + * quoted, and thus case-sensitive! */ Table asTable(String alias); }