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

[#6441] Improve TableLike.field(Field) Javadoc

Browse Source
This commit is contained in:
lukaseder 2017-07-24 14:58:24 +02:00
parent 36eba8110e
commit 339fa0db3e
7 changed files with 91 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
jOOQ/src/main/java/org/jooq/Cursor.java
View File

@ -85,8 +85,19 @@ public interface Cursor<R extends Record> extends Iterable<R> , AutoCloseable {
/**
* Get a specific field from this Cursor.
* <p>
* Usually, this will return the field itself. However, if this is a row
* from an aliased table, the field will be aliased accordingly.
* This will return:
* <ul>
* <li>A field that is the same as the argument field (by identity
* comparison).</li>
* <li>A field that is equal to the argument field (exact matching fully
* qualified name).</li>
* <li>A field that is equal to the argument field (partially matching
* qualified name).</li>
* <li>A field whose name is equal to the name of the argument field.</li>
* <li><code>null</code> otherwise.
* </ul>
* If several fields have the same name, the first one is returned and a
* warning is logged.
*
* @see Row#field(Field)
*/

15
jOOQ/src/main/java/org/jooq/Record.java
View File

@ -112,8 +112,19 @@ public interface Record extends Attachable, Comparable<Record> {
/**
* Get a specific field from this Record.
* <p>
* Usually, this will return the field itself. However, if this is a row
* from an aliased table, the field will be aliased accordingly.
* This will return:
* <ul>
* <li>A field that is the same as the argument field (by identity
* comparison).</li>
* <li>A field that is equal to the argument field (exact matching fully
* qualified name).</li>
* <li>A field that is equal to the argument field (partially matching
* qualified name).</li>
* <li>A field whose name is equal to the name of the argument field.</li>
* <li><code>null</code> otherwise.
* </ul>
* If several fields have the same name, the first one is returned and a
* warning is logged.
*
* @see Row#field(Field)
*/

15
jOOQ/src/main/java/org/jooq/RecordType.java
View File

@ -58,8 +58,19 @@ public interface RecordType<R extends Record> {
/**
* Get a specific field from this record type.
* <p>
* Usually, this will return the field itself. However, if this is a row
* type from an aliased table, the field will be aliased accordingly.
* This will return:
* <ul>
* <li>A field that is the same as the argument field (by identity
* comparison).</li>
* <li>A field that is equal to the argument field (exact matching fully
* qualified name).</li>
* <li>A field that is equal to the argument field (partially matching
* qualified name).</li>
* <li>A field whose name is equal to the name of the argument field.</li>
* <li><code>null</code> otherwise.
* </ul>
* If several fields have the same name, the first one is returned and a
* warning is logged.
*
* @param <T> The generic field type
* @param field The field to fetch

15
jOOQ/src/main/java/org/jooq/Result.java
View File

@ -79,8 +79,19 @@ public interface Result<R extends Record> extends List<R>, Attachable {
/**
* Get a specific field from this Result.
* <p>
* Usually, this will return the field itself. However, if this is a row
* from an aliased table, the field will be aliased accordingly.
* This will return:
* <ul>
* <li>A field that is the same as the argument field (by identity
* comparison).</li>
* <li>A field that is equal to the argument field (exact matching fully
* qualified name).</li>
* <li>A field that is equal to the argument field (partially matching
* qualified name).</li>
* <li>A field whose name is equal to the name of the argument field.</li>
* <li><code>null</code> otherwise.
* </ul>
* If several fields have the same name, the first one is returned and a
* warning is logged.
*
* @see Row#field(Field)
*/

15
jOOQ/src/main/java/org/jooq/Row.java
View File

@ -62,8 +62,19 @@ public interface Row extends FieldOrRow {
/**
* Get a specific field from this row.
* <p>
* Usually, this will return the field itself. However, if this is a row
* from an aliased table, the field will be aliased accordingly.
* This will return:
* <ul>
* <li>A field that is the same as the argument field (by identity
* comparison).</li>
* <li>A field that is equal to the argument field (exact matching fully
* qualified name).</li>
* <li>A field that is equal to the argument field (partially matching
* qualified name).</li>
* <li>A field whose name is equal to the name of the argument field.</li>
* <li><code>null</code> otherwise.
* </ul>
* If several fields have the same name, the first one is returned and a
* warning is logged.
*
* @param <T> The generic field type
* @param field The field to fetch

15
jOOQ/src/main/java/org/jooq/TableLike.java
View File

@ -61,8 +61,19 @@ public interface TableLike<R extends Record> extends QueryPart {
/**
* Get a specific field from this table.
* <p>
* Usually, this will return the field itself. However, if this is a row
* from an aliased table, the field will be aliased accordingly.
* This will return:
* <ul>
* <li>A field that is the same as the argument field (by identity
* comparison).</li>
* <li>A field that is equal to the argument field (exact matching fully
* qualified name).</li>
* <li>A field that is equal to the argument field (partially matching
* qualified name).</li>
* <li>A field whose name is equal to the name of the argument field.</li>
* <li><code>null</code> otherwise.
* </ul>
* If several fields have the same name, the first one is returned and a
* warning is logged.
*
* @see Row#field(Field)
*/

15
jOOQ/src/main/java/org/jooq/UDT.java
View File

@ -59,8 +59,19 @@ public interface UDT<R extends UDTRecord<R>> extends QueryPart {
/**
* Get a specific field from this UDT.
* <p>
* Usually, this will return the field itself. However, if this is a row
* from an aliased UDT, the field will be aliased accordingly.
* This will return:
* <ul>
* <li>A field that is the same as the argument field (by identity
* comparison).</li>
* <li>A field that is equal to the argument field (exact matching fully
* qualified name).</li>
* <li>A field that is equal to the argument field (partially matching
* qualified name).</li>
* <li>A field whose name is equal to the name of the argument field.</li>
* <li><code>null</code> otherwise.
* </ul>
* If several fields have the same name, the first one is returned and a
* warning is logged.
*
* @see Row#field(Field)
*/