From 921436509cd5f50f2ba24d5e1469e51b3887eebc Mon Sep 17 00:00:00 2001 From: lukaseder Date: Tue, 1 Dec 2015 14:31:01 +0100 Subject: [PATCH] [#4769] Improve TableLike.field(Field) Javadoc --- jOOQ/src/main/java/org/jooq/Cursor.java | 3 +++ jOOQ/src/main/java/org/jooq/Record.java | 3 +++ jOOQ/src/main/java/org/jooq/Result.java | 3 +++ jOOQ/src/main/java/org/jooq/TableLike.java | 3 +++ jOOQ/src/main/java/org/jooq/UDT.java | 3 +++ 5 files changed, 15 insertions(+) diff --git a/jOOQ/src/main/java/org/jooq/Cursor.java b/jOOQ/src/main/java/org/jooq/Cursor.java index 9dcde1cf33..167176a9ce 100644 --- a/jOOQ/src/main/java/org/jooq/Cursor.java +++ b/jOOQ/src/main/java/org/jooq/Cursor.java @@ -82,6 +82,9 @@ public interface Cursor extends Iterable /* [java-8] */, Au /** * Get a specific field from this Cursor. + *

+ * Usually, this will return the field itself. However, if this is a row + * from an aliased table, the field will be aliased accordingly. * * @see Row#field(Field) */ diff --git a/jOOQ/src/main/java/org/jooq/Record.java b/jOOQ/src/main/java/org/jooq/Record.java index e5cfe2125d..a38b76dbce 100644 --- a/jOOQ/src/main/java/org/jooq/Record.java +++ b/jOOQ/src/main/java/org/jooq/Record.java @@ -113,6 +113,9 @@ public interface Record extends Attachable, Comparable { /** * Get a specific field from this Record. + *

+ * Usually, this will return the field itself. However, if this is a row + * from an aliased table, the field will be aliased accordingly. * * @see Row#field(Field) */ diff --git a/jOOQ/src/main/java/org/jooq/Result.java b/jOOQ/src/main/java/org/jooq/Result.java index 5657a44528..76eee47de6 100644 --- a/jOOQ/src/main/java/org/jooq/Result.java +++ b/jOOQ/src/main/java/org/jooq/Result.java @@ -84,6 +84,9 @@ public interface Result extends List, Attachable { /** * Get a specific field from this Result. + *

+ * Usually, this will return the field itself. However, if this is a row + * from an aliased table, the field will be aliased accordingly. * * @see Row#field(Field) */ diff --git a/jOOQ/src/main/java/org/jooq/TableLike.java b/jOOQ/src/main/java/org/jooq/TableLike.java index ee132a3578..7e466abcb9 100644 --- a/jOOQ/src/main/java/org/jooq/TableLike.java +++ b/jOOQ/src/main/java/org/jooq/TableLike.java @@ -55,6 +55,9 @@ public interface TableLike extends QueryPart { /** * Get a specific field from this table. + *

+ * Usually, this will return the field itself. However, if this is a row + * from an aliased table, the field will be aliased accordingly. * * @see Row#field(Field) */ diff --git a/jOOQ/src/main/java/org/jooq/UDT.java b/jOOQ/src/main/java/org/jooq/UDT.java index 193331619b..3d2a0e4372 100644 --- a/jOOQ/src/main/java/org/jooq/UDT.java +++ b/jOOQ/src/main/java/org/jooq/UDT.java @@ -57,6 +57,9 @@ public interface UDT> extends QueryPart { /** * Get a specific field from this UDT. + *

+ * Usually, this will return the field itself. However, if this is a row + * from an aliased UDT, the field will be aliased accordingly. * * @see Row#field(Field) */