diff --git a/jOOQ/src/main/java/org/jooq/AggregateFunction.java b/jOOQ/src/main/java/org/jooq/AggregateFunction.java index 30aef91640..38b5652486 100644 --- a/jOOQ/src/main/java/org/jooq/AggregateFunction.java +++ b/jOOQ/src/main/java/org/jooq/AggregateFunction.java @@ -41,11 +41,16 @@ package org.jooq; import java.util.Collection; +import org.jooq.impl.DSL; + /** * An aggregate function is a special field that is usually used in a * GROUP BY context. It is also the base for window function * construction. + *

+ * Instances can be created using various {@link DSL} methods and their + * overloads, such as {@link DSL#count()} or {@link DSL#countDistinct(Field)}. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Asterisk.java b/jOOQ/src/main/java/org/jooq/Asterisk.java index a4d30f1b61..d8649ae405 100644 --- a/jOOQ/src/main/java/org/jooq/Asterisk.java +++ b/jOOQ/src/main/java/org/jooq/Asterisk.java @@ -37,10 +37,13 @@ */ package org.jooq; +import org.jooq.impl.DSL; /** * A QueryPart to be used exclusively in SELECT * clauses. + *

+ * Instances can be created using {@link DSL#asterisk()}. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Block.java b/jOOQ/src/main/java/org/jooq/Block.java index f610cd40d7..8f0210d58a 100644 --- a/jOOQ/src/main/java/org/jooq/Block.java +++ b/jOOQ/src/main/java/org/jooq/Block.java @@ -37,8 +37,12 @@ */ package org.jooq; +import org.jooq.impl.DSL; + /** - * A query that models an anonymous procedural block + * A query that models an anonymous procedural block. + *

+ * Instances can be created using {@link DSL#begin(Statement...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Catalog.java b/jOOQ/src/main/java/org/jooq/Catalog.java index d9a4d37dcd..f5464dfb4f 100644 --- a/jOOQ/src/main/java/org/jooq/Catalog.java +++ b/jOOQ/src/main/java/org/jooq/Catalog.java @@ -40,8 +40,12 @@ package org.jooq; import java.util.List; import java.util.stream.Stream; +import org.jooq.impl.DSL; + /** * An object representing a database catalog. + *

+ * Instances can be created using {@link DSL#catalog(Name)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Collation.java b/jOOQ/src/main/java/org/jooq/Collation.java index 74890d8a6e..e901485218 100644 --- a/jOOQ/src/main/java/org/jooq/Collation.java +++ b/jOOQ/src/main/java/org/jooq/Collation.java @@ -37,8 +37,12 @@ */ package org.jooq; +import org.jooq.impl.DSL; + /** * A collation. + *

+ * Instances can be created using {@link DSL#collation(Name)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Comment.java b/jOOQ/src/main/java/org/jooq/Comment.java index cd54b46a93..66ceff54d2 100644 --- a/jOOQ/src/main/java/org/jooq/Comment.java +++ b/jOOQ/src/main/java/org/jooq/Comment.java @@ -37,8 +37,12 @@ */ package org.jooq; +import org.jooq.impl.DSL; + /** * A meta model for SQL comments on tables, fields, etc. + *

+ * Instances can be created using {@link DSL#comment(String)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/CommonTableExpression.java b/jOOQ/src/main/java/org/jooq/CommonTableExpression.java index 860d16c75e..e7ab9d5192 100644 --- a/jOOQ/src/main/java/org/jooq/CommonTableExpression.java +++ b/jOOQ/src/main/java/org/jooq/CommonTableExpression.java @@ -40,6 +40,8 @@ package org.jooq; /** * A common table expression is a table that can be supplied to * WITH clauses. + *

+ * Instances can be created using {@link Name#as(Select)}. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Condition.java b/jOOQ/src/main/java/org/jooq/Condition.java index 981543b86c..fad72915c1 100644 --- a/jOOQ/src/main/java/org/jooq/Condition.java +++ b/jOOQ/src/main/java/org/jooq/Condition.java @@ -42,7 +42,11 @@ import org.jooq.impl.DSL; /** - * A condition to be used in a query's where part + * A condition to be used in a query's where part. + *

+ * Instances can be created using {@link DSL#condition(Field)} and overloads, or + * by calling a comparison operator method on {@link Field}, such as + * {@link Field#eq(Field)}. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Constraint.java b/jOOQ/src/main/java/org/jooq/Constraint.java index 7707c2731a..a4f64e2349 100644 --- a/jOOQ/src/main/java/org/jooq/Constraint.java +++ b/jOOQ/src/main/java/org/jooq/Constraint.java @@ -37,8 +37,12 @@ */ package org.jooq; +import org.jooq.impl.DSL; + /** * A DDL constraint. + *

+ * Instances can be created using {@link DSL#constraint(Name)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Declaration.java b/jOOQ/src/main/java/org/jooq/Declaration.java index f71684a051..2de0d8bc5e 100644 --- a/jOOQ/src/main/java/org/jooq/Declaration.java +++ b/jOOQ/src/main/java/org/jooq/Declaration.java @@ -58,6 +58,10 @@ package org.jooq; + + + + diff --git a/jOOQ/src/main/java/org/jooq/Delete.java b/jOOQ/src/main/java/org/jooq/Delete.java index 5168cdca5a..d5428f72a8 100644 --- a/jOOQ/src/main/java/org/jooq/Delete.java +++ b/jOOQ/src/main/java/org/jooq/Delete.java @@ -37,9 +37,14 @@ */ package org.jooq; +import org.jooq.impl.DSL; /** * A {@link Query} that can delete data in the database. + *

+ * Instances can be created using {@link DSL#deleteFrom(Table)}, + * {@link DSLContext#deleteFrom(Table)}, or + * {@link DSLContext#deleteQuery(Table)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/DeleteQuery.java b/jOOQ/src/main/java/org/jooq/DeleteQuery.java index 53482c7020..bfd0396bfd 100644 --- a/jOOQ/src/main/java/org/jooq/DeleteQuery.java +++ b/jOOQ/src/main/java/org/jooq/DeleteQuery.java @@ -47,7 +47,9 @@ import static org.jooq.SQLDialect.POSTGRES; import java.util.Collection; /** - * A query used for deletion of data + * A query used for deletion of data. + *

+ * Instances can be created using {@link DSLContext#deleteQuery(Table)}. * * @param The record type of the table being deleted from * @author Lukas Eder diff --git a/jOOQ/src/main/java/org/jooq/DerivedColumnList.java b/jOOQ/src/main/java/org/jooq/DerivedColumnList.java index bf0b4aaf45..88de19c45e 100644 --- a/jOOQ/src/main/java/org/jooq/DerivedColumnList.java +++ b/jOOQ/src/main/java/org/jooq/DerivedColumnList.java @@ -57,7 +57,9 @@ import static org.jooq.SQLDialect.POSTGRES; * optional derived column list. *

* An example of a correlation name with derived column list is: - * table(column1, column2) + * table(column1, column2). + *

+ * Instances can be created using {@link Name#fields(String...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/DerivedColumnList1.java b/jOOQ/src/main/java/org/jooq/DerivedColumnList1.java index 020e6ba087..6d67d2e1c4 100644 --- a/jOOQ/src/main/java/org/jooq/DerivedColumnList1.java +++ b/jOOQ/src/main/java/org/jooq/DerivedColumnList1.java @@ -57,7 +57,9 @@ import static org.jooq.SQLDialect.POSTGRES; * optional derived column list. *

* An example of a correlation name with derived column list is: - * table(column1, column2) + * table(column1, column2). + *

+ * Instances can be created using {@link Name#fields(String...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/DerivedColumnList10.java b/jOOQ/src/main/java/org/jooq/DerivedColumnList10.java index 1d84c1a1f3..ab93d84cfc 100644 --- a/jOOQ/src/main/java/org/jooq/DerivedColumnList10.java +++ b/jOOQ/src/main/java/org/jooq/DerivedColumnList10.java @@ -57,7 +57,9 @@ import static org.jooq.SQLDialect.POSTGRES; * optional derived column list. *

* An example of a correlation name with derived column list is: - * table(column1, column2) + * table(column1, column2). + *

+ * Instances can be created using {@link Name#fields(String...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/DerivedColumnList11.java b/jOOQ/src/main/java/org/jooq/DerivedColumnList11.java index a29944f475..bda32f407d 100644 --- a/jOOQ/src/main/java/org/jooq/DerivedColumnList11.java +++ b/jOOQ/src/main/java/org/jooq/DerivedColumnList11.java @@ -57,7 +57,9 @@ import static org.jooq.SQLDialect.POSTGRES; * optional derived column list. *

* An example of a correlation name with derived column list is: - * table(column1, column2) + * table(column1, column2). + *

+ * Instances can be created using {@link Name#fields(String...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/DerivedColumnList12.java b/jOOQ/src/main/java/org/jooq/DerivedColumnList12.java index a24c3ee271..00120ca8a2 100644 --- a/jOOQ/src/main/java/org/jooq/DerivedColumnList12.java +++ b/jOOQ/src/main/java/org/jooq/DerivedColumnList12.java @@ -57,7 +57,9 @@ import static org.jooq.SQLDialect.POSTGRES; * optional derived column list. *

* An example of a correlation name with derived column list is: - * table(column1, column2) + * table(column1, column2). + *

+ * Instances can be created using {@link Name#fields(String...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/DerivedColumnList13.java b/jOOQ/src/main/java/org/jooq/DerivedColumnList13.java index a7d1ce8824..f70564555b 100644 --- a/jOOQ/src/main/java/org/jooq/DerivedColumnList13.java +++ b/jOOQ/src/main/java/org/jooq/DerivedColumnList13.java @@ -57,7 +57,9 @@ import static org.jooq.SQLDialect.POSTGRES; * optional derived column list. *

* An example of a correlation name with derived column list is: - * table(column1, column2) + * table(column1, column2). + *

+ * Instances can be created using {@link Name#fields(String...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/DerivedColumnList14.java b/jOOQ/src/main/java/org/jooq/DerivedColumnList14.java index ee0ba2f9d2..94fcdbf5b6 100644 --- a/jOOQ/src/main/java/org/jooq/DerivedColumnList14.java +++ b/jOOQ/src/main/java/org/jooq/DerivedColumnList14.java @@ -57,7 +57,9 @@ import static org.jooq.SQLDialect.POSTGRES; * optional derived column list. *

* An example of a correlation name with derived column list is: - * table(column1, column2) + * table(column1, column2). + *

+ * Instances can be created using {@link Name#fields(String...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/DerivedColumnList15.java b/jOOQ/src/main/java/org/jooq/DerivedColumnList15.java index 0ed289e398..fe0c661dfd 100644 --- a/jOOQ/src/main/java/org/jooq/DerivedColumnList15.java +++ b/jOOQ/src/main/java/org/jooq/DerivedColumnList15.java @@ -57,7 +57,9 @@ import static org.jooq.SQLDialect.POSTGRES; * optional derived column list. *

* An example of a correlation name with derived column list is: - * table(column1, column2) + * table(column1, column2). + *

+ * Instances can be created using {@link Name#fields(String...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/DerivedColumnList16.java b/jOOQ/src/main/java/org/jooq/DerivedColumnList16.java index a8b9e78139..d23e8c168f 100644 --- a/jOOQ/src/main/java/org/jooq/DerivedColumnList16.java +++ b/jOOQ/src/main/java/org/jooq/DerivedColumnList16.java @@ -57,7 +57,9 @@ import static org.jooq.SQLDialect.POSTGRES; * optional derived column list. *

* An example of a correlation name with derived column list is: - * table(column1, column2) + * table(column1, column2). + *

+ * Instances can be created using {@link Name#fields(String...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/DerivedColumnList17.java b/jOOQ/src/main/java/org/jooq/DerivedColumnList17.java index 6d9045d8c2..e6146cb322 100644 --- a/jOOQ/src/main/java/org/jooq/DerivedColumnList17.java +++ b/jOOQ/src/main/java/org/jooq/DerivedColumnList17.java @@ -57,7 +57,9 @@ import static org.jooq.SQLDialect.POSTGRES; * optional derived column list. *

* An example of a correlation name with derived column list is: - * table(column1, column2) + * table(column1, column2). + *

+ * Instances can be created using {@link Name#fields(String...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/DerivedColumnList18.java b/jOOQ/src/main/java/org/jooq/DerivedColumnList18.java index 9a882d3d79..db440a892e 100644 --- a/jOOQ/src/main/java/org/jooq/DerivedColumnList18.java +++ b/jOOQ/src/main/java/org/jooq/DerivedColumnList18.java @@ -57,7 +57,9 @@ import static org.jooq.SQLDialect.POSTGRES; * optional derived column list. *

* An example of a correlation name with derived column list is: - * table(column1, column2) + * table(column1, column2). + *

+ * Instances can be created using {@link Name#fields(String...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/DerivedColumnList19.java b/jOOQ/src/main/java/org/jooq/DerivedColumnList19.java index 198eeb634f..fc135f6a37 100644 --- a/jOOQ/src/main/java/org/jooq/DerivedColumnList19.java +++ b/jOOQ/src/main/java/org/jooq/DerivedColumnList19.java @@ -57,7 +57,9 @@ import static org.jooq.SQLDialect.POSTGRES; * optional derived column list. *

* An example of a correlation name with derived column list is: - * table(column1, column2) + * table(column1, column2). + *

+ * Instances can be created using {@link Name#fields(String...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/DerivedColumnList2.java b/jOOQ/src/main/java/org/jooq/DerivedColumnList2.java index db8367da51..c1d4b25806 100644 --- a/jOOQ/src/main/java/org/jooq/DerivedColumnList2.java +++ b/jOOQ/src/main/java/org/jooq/DerivedColumnList2.java @@ -57,7 +57,9 @@ import static org.jooq.SQLDialect.POSTGRES; * optional derived column list. *

* An example of a correlation name with derived column list is: - * table(column1, column2) + * table(column1, column2). + *

+ * Instances can be created using {@link Name#fields(String...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/DerivedColumnList20.java b/jOOQ/src/main/java/org/jooq/DerivedColumnList20.java index 985100de24..eb54739504 100644 --- a/jOOQ/src/main/java/org/jooq/DerivedColumnList20.java +++ b/jOOQ/src/main/java/org/jooq/DerivedColumnList20.java @@ -57,7 +57,9 @@ import static org.jooq.SQLDialect.POSTGRES; * optional derived column list. *

* An example of a correlation name with derived column list is: - * table(column1, column2) + * table(column1, column2). + *

+ * Instances can be created using {@link Name#fields(String...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/DerivedColumnList21.java b/jOOQ/src/main/java/org/jooq/DerivedColumnList21.java index 9cb93dd8e9..c74cbfcd9b 100644 --- a/jOOQ/src/main/java/org/jooq/DerivedColumnList21.java +++ b/jOOQ/src/main/java/org/jooq/DerivedColumnList21.java @@ -57,7 +57,9 @@ import static org.jooq.SQLDialect.POSTGRES; * optional derived column list. *

* An example of a correlation name with derived column list is: - * table(column1, column2) + * table(column1, column2). + *

+ * Instances can be created using {@link Name#fields(String...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/DerivedColumnList22.java b/jOOQ/src/main/java/org/jooq/DerivedColumnList22.java index fb1118f7d1..20fd647774 100644 --- a/jOOQ/src/main/java/org/jooq/DerivedColumnList22.java +++ b/jOOQ/src/main/java/org/jooq/DerivedColumnList22.java @@ -57,7 +57,9 @@ import static org.jooq.SQLDialect.POSTGRES; * optional derived column list. *

* An example of a correlation name with derived column list is: - * table(column1, column2) + * table(column1, column2). + *

+ * Instances can be created using {@link Name#fields(String...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/DerivedColumnList3.java b/jOOQ/src/main/java/org/jooq/DerivedColumnList3.java index f42b47b773..725545dd50 100644 --- a/jOOQ/src/main/java/org/jooq/DerivedColumnList3.java +++ b/jOOQ/src/main/java/org/jooq/DerivedColumnList3.java @@ -57,7 +57,9 @@ import static org.jooq.SQLDialect.POSTGRES; * optional derived column list. *

* An example of a correlation name with derived column list is: - * table(column1, column2) + * table(column1, column2). + *

+ * Instances can be created using {@link Name#fields(String...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/DerivedColumnList4.java b/jOOQ/src/main/java/org/jooq/DerivedColumnList4.java index 8f64de28d9..52780686b7 100644 --- a/jOOQ/src/main/java/org/jooq/DerivedColumnList4.java +++ b/jOOQ/src/main/java/org/jooq/DerivedColumnList4.java @@ -57,7 +57,9 @@ import static org.jooq.SQLDialect.POSTGRES; * optional derived column list. *

* An example of a correlation name with derived column list is: - * table(column1, column2) + * table(column1, column2). + *

+ * Instances can be created using {@link Name#fields(String...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/DerivedColumnList5.java b/jOOQ/src/main/java/org/jooq/DerivedColumnList5.java index 22b034e00a..8d377b038f 100644 --- a/jOOQ/src/main/java/org/jooq/DerivedColumnList5.java +++ b/jOOQ/src/main/java/org/jooq/DerivedColumnList5.java @@ -57,7 +57,9 @@ import static org.jooq.SQLDialect.POSTGRES; * optional derived column list. *

* An example of a correlation name with derived column list is: - * table(column1, column2) + * table(column1, column2). + *

+ * Instances can be created using {@link Name#fields(String...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/DerivedColumnList6.java b/jOOQ/src/main/java/org/jooq/DerivedColumnList6.java index fcbe4186d0..c34a1cd627 100644 --- a/jOOQ/src/main/java/org/jooq/DerivedColumnList6.java +++ b/jOOQ/src/main/java/org/jooq/DerivedColumnList6.java @@ -57,7 +57,9 @@ import static org.jooq.SQLDialect.POSTGRES; * optional derived column list. *

* An example of a correlation name with derived column list is: - * table(column1, column2) + * table(column1, column2). + *

+ * Instances can be created using {@link Name#fields(String...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/DerivedColumnList7.java b/jOOQ/src/main/java/org/jooq/DerivedColumnList7.java index fae090d536..295e94bab5 100644 --- a/jOOQ/src/main/java/org/jooq/DerivedColumnList7.java +++ b/jOOQ/src/main/java/org/jooq/DerivedColumnList7.java @@ -57,7 +57,9 @@ import static org.jooq.SQLDialect.POSTGRES; * optional derived column list. *

* An example of a correlation name with derived column list is: - * table(column1, column2) + * table(column1, column2). + *

+ * Instances can be created using {@link Name#fields(String...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/DerivedColumnList8.java b/jOOQ/src/main/java/org/jooq/DerivedColumnList8.java index 9f1d7ce8fe..78af5aa85d 100644 --- a/jOOQ/src/main/java/org/jooq/DerivedColumnList8.java +++ b/jOOQ/src/main/java/org/jooq/DerivedColumnList8.java @@ -57,7 +57,9 @@ import static org.jooq.SQLDialect.POSTGRES; * optional derived column list. *

* An example of a correlation name with derived column list is: - * table(column1, column2) + * table(column1, column2). + *

+ * Instances can be created using {@link Name#fields(String...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/DerivedColumnList9.java b/jOOQ/src/main/java/org/jooq/DerivedColumnList9.java index 1da768bcb9..659aa4157b 100644 --- a/jOOQ/src/main/java/org/jooq/DerivedColumnList9.java +++ b/jOOQ/src/main/java/org/jooq/DerivedColumnList9.java @@ -57,7 +57,9 @@ import static org.jooq.SQLDialect.POSTGRES; * optional derived column list. *

* An example of a correlation name with derived column list is: - * table(column1, column2) + * table(column1, column2). + *

+ * Instances can be created using {@link Name#fields(String...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/False.java b/jOOQ/src/main/java/org/jooq/False.java index 6a462b0f12..f5efcc04f5 100644 --- a/jOOQ/src/main/java/org/jooq/False.java +++ b/jOOQ/src/main/java/org/jooq/False.java @@ -37,8 +37,12 @@ */ package org.jooq; +import org.jooq.impl.DSL; + /** * A predicate that always yields false. + *

+ * Instances can be created using {@link DSL#falseCondition()}. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Field.java b/jOOQ/src/main/java/org/jooq/Field.java index c7fff3bf89..dd8a8bb7b4 100644 --- a/jOOQ/src/main/java/org/jooq/Field.java +++ b/jOOQ/src/main/java/org/jooq/Field.java @@ -75,10 +75,21 @@ import org.jooq.types.Interval; // ... /** - * A field used in tables and conditions + * A field used in tables and conditions. *

* Note that all fields qualify as {@link GroupField}, i.e. they can always be - * used in GROUP BY clauses + * used in GROUP BY clauses. + *

+ * Instances can be created using a variety of ways, including: + *

* * @param The field type * @author Lukas Eder diff --git a/jOOQ/src/main/java/org/jooq/FieldLike.java b/jOOQ/src/main/java/org/jooq/FieldLike.java index 5a47aa6bbb..f9f304c108 100644 --- a/jOOQ/src/main/java/org/jooq/FieldLike.java +++ b/jOOQ/src/main/java/org/jooq/FieldLike.java @@ -42,7 +42,9 @@ import java.util.function.Function; import org.jooq.conf.Settings; /** - * An object that can behave like a field (a field-like object) + * An object that can behave like a field (a field-like object). + *

+ * Instances of this type cannot be created directly, only of its subtypes. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/FieldOrConstraint.java b/jOOQ/src/main/java/org/jooq/FieldOrConstraint.java index ad8f98a599..6415c76d3d 100644 --- a/jOOQ/src/main/java/org/jooq/FieldOrConstraint.java +++ b/jOOQ/src/main/java/org/jooq/FieldOrConstraint.java @@ -42,6 +42,8 @@ package org.jooq; * both types alike. *

* This is useful for DDL statements. + *

+ * Instances of this type cannot be created directly, only of its subtypes. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/FieldOrRow.java b/jOOQ/src/main/java/org/jooq/FieldOrRow.java index 83f4d975e9..f06adf6783 100644 --- a/jOOQ/src/main/java/org/jooq/FieldOrRow.java +++ b/jOOQ/src/main/java/org/jooq/FieldOrRow.java @@ -50,6 +50,8 @@ package org.jooq; * ROLLUP ( a, (b,c), d ) * * + *

+ * Instances of this type cannot be created directly, only of its subtypes. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/ForeignKey.java b/jOOQ/src/main/java/org/jooq/ForeignKey.java index 1414601fd2..229fbe4378 100644 --- a/jOOQ/src/main/java/org/jooq/ForeignKey.java +++ b/jOOQ/src/main/java/org/jooq/ForeignKey.java @@ -44,6 +44,9 @@ import org.jooq.exception.DataAccessException; /** * A ForeignKey is an object referencing a {@link UniqueKey}. It * represents a FOREIGN KEY relationship between two tables. + *

+ * Instances of this type cannot be created directly. They are available from + * generated code. * * @param The FOREIGN KEY's owner table record * @param The referenced KEY's owner table record diff --git a/jOOQ/src/main/java/org/jooq/GroupField.java b/jOOQ/src/main/java/org/jooq/GroupField.java index 4290ae883d..0025ca26f9 100644 --- a/jOOQ/src/main/java/org/jooq/GroupField.java +++ b/jOOQ/src/main/java/org/jooq/GroupField.java @@ -37,10 +37,14 @@ */ package org.jooq; +import org.jooq.impl.DSL; /** * A QueryPart to be used exclusively in GROUP BY - * clauses + * clauses. + *

+ * Instances can be created using {@link DSL#groupingSets(Field[][])} and + * related methods, or by creating a subtype. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Identity.java b/jOOQ/src/main/java/org/jooq/Identity.java index 1581a2310d..82811e5e73 100644 --- a/jOOQ/src/main/java/org/jooq/Identity.java +++ b/jOOQ/src/main/java/org/jooq/Identity.java @@ -44,6 +44,9 @@ import java.io.Serializable; * column as understood by the SQL:2003 standard. In most RDBMS, this is * actually called an IDENTITY column. Some RDMBS such as MySQL * call it AUTO_INCREMENT columns. + *

+ * Instances of this type cannot be created directly. They are available from + * generated code. * * @param The IDENTITY's owner table record * @param The IDENTITY's field type diff --git a/jOOQ/src/main/java/org/jooq/Index.java b/jOOQ/src/main/java/org/jooq/Index.java index cec5c7e0e1..e2ced359d3 100644 --- a/jOOQ/src/main/java/org/jooq/Index.java +++ b/jOOQ/src/main/java/org/jooq/Index.java @@ -39,8 +39,12 @@ package org.jooq; import java.util.List; +import org.jooq.impl.DSL; + /** * A DDL index definition. + *

+ * Instances can be created using {@link DSL#index(Name)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Insert.java b/jOOQ/src/main/java/org/jooq/Insert.java index 82ff3e691b..cc1d9c2f90 100644 --- a/jOOQ/src/main/java/org/jooq/Insert.java +++ b/jOOQ/src/main/java/org/jooq/Insert.java @@ -37,8 +37,13 @@ */ package org.jooq; +import org.jooq.impl.DSL; + /** * A {@link Query} that can insert data in the database. + *

+ * Instances can be created using {@link DSL#insertInto(Table)}, or + * {@link DSLContext#insertQuery(Table)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/InsertQuery.java b/jOOQ/src/main/java/org/jooq/InsertQuery.java index e2be9ee7ef..a7279aed64 100644 --- a/jOOQ/src/main/java/org/jooq/InsertQuery.java +++ b/jOOQ/src/main/java/org/jooq/InsertQuery.java @@ -65,7 +65,10 @@ import java.util.Collection; import java.util.Map; /** - * A query for data insertion + * A query for data insertion. + *

+ * Instances can be created using {@link DSLContext#insertQuery(Table)} and + * overloads. * * @param The record type of the table being inserted into * @author Lukas Eder diff --git a/jOOQ/src/main/java/org/jooq/JoinType.java b/jOOQ/src/main/java/org/jooq/JoinType.java index a5b8f46c08..ec23adf477 100644 --- a/jOOQ/src/main/java/org/jooq/JoinType.java +++ b/jOOQ/src/main/java/org/jooq/JoinType.java @@ -65,7 +65,7 @@ import static org.jooq.SQLDialect.POSTGRES; import org.jooq.impl.DSL; /** - * The type of join + * The type of join. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Key.java b/jOOQ/src/main/java/org/jooq/Key.java index 358136449e..b53424bab7 100644 --- a/jOOQ/src/main/java/org/jooq/Key.java +++ b/jOOQ/src/main/java/org/jooq/Key.java @@ -44,6 +44,9 @@ import java.util.List; /** * A Key is an object representing a UNIQUE KEY, a * PRIMARY KEY, or a FOREIGN KEY. + *

+ * Instances of this type cannot be created directly. They are available from + * generated code. * * @param The KEY's owner table record * @author Lukas Eder diff --git a/jOOQ/src/main/java/org/jooq/Keyword.java b/jOOQ/src/main/java/org/jooq/Keyword.java index 16c4e133dd..6806b6c56e 100644 --- a/jOOQ/src/main/java/org/jooq/Keyword.java +++ b/jOOQ/src/main/java/org/jooq/Keyword.java @@ -38,6 +38,7 @@ package org.jooq; import org.jooq.conf.Settings; +import org.jooq.impl.DSL; /** * A SQL keyword QueryPart. @@ -45,6 +46,8 @@ import org.jooq.conf.Settings; * A Keyword is a {@link QueryPart} that renders a SQL keyword * according to the settings specified in * {@link Settings#getRenderKeywordCase()}. + *

+ * Instances can be created using {@link DSL#keyword(String)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Label.java b/jOOQ/src/main/java/org/jooq/Label.java index 8a40ece199..33413abb24 100644 --- a/jOOQ/src/main/java/org/jooq/Label.java +++ b/jOOQ/src/main/java/org/jooq/Label.java @@ -52,4 +52,8 @@ package org.jooq; + + + + \ No newline at end of file diff --git a/jOOQ/src/main/java/org/jooq/Link.java b/jOOQ/src/main/java/org/jooq/Link.java index 6abca20dd2..05d3788795 100644 --- a/jOOQ/src/main/java/org/jooq/Link.java +++ b/jOOQ/src/main/java/org/jooq/Link.java @@ -52,6 +52,10 @@ package org.jooq; + + + + diff --git a/jOOQ/src/main/java/org/jooq/Merge.java b/jOOQ/src/main/java/org/jooq/Merge.java index db6f4ef8eb..64fa9a37f7 100644 --- a/jOOQ/src/main/java/org/jooq/Merge.java +++ b/jOOQ/src/main/java/org/jooq/Merge.java @@ -37,9 +37,12 @@ */ package org.jooq; +import org.jooq.impl.DSL; /** * A {@link Query} that can merge data in the database. + *

+ * Instances can be created using {@link DSL#mergeInto(Table)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Name.java b/jOOQ/src/main/java/org/jooq/Name.java index 228ee54341..44edf61686 100644 --- a/jOOQ/src/main/java/org/jooq/Name.java +++ b/jOOQ/src/main/java/org/jooq/Name.java @@ -61,6 +61,7 @@ import java.util.function.Function; import org.jooq.conf.RenderQuotedNames; import org.jooq.conf.Settings; +import org.jooq.impl.DSL; /** * A SQL identifier QueryPart. @@ -69,6 +70,8 @@ import org.jooq.conf.Settings; * according to the settings specified in * {@link Settings#getRenderQuotedNames()} and * {@link Settings#getRenderNameCase()}. + *

+ * Instances can be created using {@link DSL#name(String)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Named.java b/jOOQ/src/main/java/org/jooq/Named.java index 39aaab5f4c..91a442ffea 100644 --- a/jOOQ/src/main/java/org/jooq/Named.java +++ b/jOOQ/src/main/java/org/jooq/Named.java @@ -39,6 +39,8 @@ package org.jooq; /** * A common base type for all qualifiable, named objects. + *

+ * Instances of this type cannot be created directly, only of its subtypes. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/OrderField.java b/jOOQ/src/main/java/org/jooq/OrderField.java index 97cc332aa3..c92783d308 100644 --- a/jOOQ/src/main/java/org/jooq/OrderField.java +++ b/jOOQ/src/main/java/org/jooq/OrderField.java @@ -41,6 +41,8 @@ package org.jooq; /** * A QueryPart to be used exclusively in ORDER BY * clauses. + *

+ * Instances of this type cannot be created directly, only of its subtypes. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Package.java b/jOOQ/src/main/java/org/jooq/Package.java index 53c41db8ba..5bad6f9963 100644 --- a/jOOQ/src/main/java/org/jooq/Package.java +++ b/jOOQ/src/main/java/org/jooq/Package.java @@ -40,7 +40,10 @@ package org.jooq; /** * A container for stored procedures and functions *

- * This is only supported in the {@link SQLDialect#ORACLE} dialect + * This is only supported in the {@link SQLDialect#ORACLE} dialect. + *

+ * Instances of this type cannot be created directly. They are available from + * generated code. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Param.java b/jOOQ/src/main/java/org/jooq/Param.java index da2f646dc6..f815352241 100644 --- a/jOOQ/src/main/java/org/jooq/Param.java +++ b/jOOQ/src/main/java/org/jooq/Param.java @@ -44,6 +44,9 @@ import org.jooq.tools.Convert; /** * A named parameter and/or bind value. + *

+ * Instances can be created using {@link DSL#param(String, Object)}, + * {@link DSL#val(Object)}, {@link DSL#inline(Object)} and respective overloads. * * @author Lukas Eder * @see DSL#param(String, Object) diff --git a/jOOQ/src/main/java/org/jooq/Parameter.java b/jOOQ/src/main/java/org/jooq/Parameter.java index 941ba5a439..9aa5792abe 100644 --- a/jOOQ/src/main/java/org/jooq/Parameter.java +++ b/jOOQ/src/main/java/org/jooq/Parameter.java @@ -41,6 +41,9 @@ package org.jooq; /** * A parameter to a stored procedure or function. + *

+ * Instances of this type cannot be created directly. They are available from + * generated code. * * @param The parameter type * @author Lukas Eder diff --git a/jOOQ/src/main/java/org/jooq/Privilege.java b/jOOQ/src/main/java/org/jooq/Privilege.java index a8631eccb5..dc94ab0195 100644 --- a/jOOQ/src/main/java/org/jooq/Privilege.java +++ b/jOOQ/src/main/java/org/jooq/Privilege.java @@ -37,7 +37,13 @@ */ package org.jooq; +import org.jooq.impl.DSL; + /** + * A privilege for use in GRANT statements. + *

+ * Instances can be created using {@link DSL#privilege(String)} and overloads. + * * @author Timur Shaidullin */ public interface Privilege extends QueryPart { diff --git a/jOOQ/src/main/java/org/jooq/QualifiedAsterisk.java b/jOOQ/src/main/java/org/jooq/QualifiedAsterisk.java index 2695929419..824078d4d1 100644 --- a/jOOQ/src/main/java/org/jooq/QualifiedAsterisk.java +++ b/jOOQ/src/main/java/org/jooq/QualifiedAsterisk.java @@ -41,6 +41,8 @@ package org.jooq; /** * A QueryPart to be used exclusively in SELECT * clauses. + *

+ * Instances can be created using {@link Table#asterisk()}. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/QuantifiedSelect.java b/jOOQ/src/main/java/org/jooq/QuantifiedSelect.java index 02c70a7488..9276ef9957 100644 --- a/jOOQ/src/main/java/org/jooq/QuantifiedSelect.java +++ b/jOOQ/src/main/java/org/jooq/QuantifiedSelect.java @@ -37,6 +37,7 @@ */ package org.jooq; +import org.jooq.impl.DSL; /** * A participant of a quantified comparison predicate @@ -47,7 +48,10 @@ package org.jooq; *

  • ANY (SELECT 1 FROM DUAL)
  • *
  • ALL (SELECT 1 FROM DUAL)
  • * - * These predicates can be used exclusively with methods, such as {@link Field} + * These predicates can be used exclusively with methods, such as {@link Field}. + *

    + * Instances can be created using {@link DSL#any(Select)} and + * {@link DSL#all(Select)}. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Queries.java b/jOOQ/src/main/java/org/jooq/Queries.java index fe2ca5db30..8bfbfe49c3 100644 --- a/jOOQ/src/main/java/org/jooq/Queries.java +++ b/jOOQ/src/main/java/org/jooq/Queries.java @@ -41,9 +41,12 @@ import java.sql.Statement; import java.util.stream.Stream; import org.jooq.exception.DetachedException; +import org.jooq.impl.DSL; /** * A wrapper for a collection of queries. + *

    + * Instances can be created using {@link DSL#queries(Query...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Query.java b/jOOQ/src/main/java/org/jooq/Query.java index e5cb672d8a..43d237c475 100644 --- a/jOOQ/src/main/java/org/jooq/Query.java +++ b/jOOQ/src/main/java/org/jooq/Query.java @@ -52,7 +52,10 @@ import org.jooq.exception.DataTypeException; import org.jooq.impl.DSL; /** - * Any query + * Any query. + *

    + * Instances can be created using {@link DSL#query(String)} and overloads, + * or by creating a subtype. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/QueryPart.java b/jOOQ/src/main/java/org/jooq/QueryPart.java index 919983a2a9..0dbe3917f7 100644 --- a/jOOQ/src/main/java/org/jooq/QueryPart.java +++ b/jOOQ/src/main/java/org/jooq/QueryPart.java @@ -43,9 +43,6 @@ import org.jooq.conf.Settings; /** * The common base type for all objects that can be used for query composition. - *

    - * All QueryPart implementations can be cast to - * {@link QueryPartInternal} in order to access the internal API. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/ResultQuery.java b/jOOQ/src/main/java/org/jooq/ResultQuery.java index fa115bc42c..7ec5139418 100644 --- a/jOOQ/src/main/java/org/jooq/ResultQuery.java +++ b/jOOQ/src/main/java/org/jooq/ResultQuery.java @@ -64,6 +64,7 @@ import org.jooq.exception.InvalidResultException; import org.jooq.exception.MappingException; import org.jooq.exception.NoDataFoundException; import org.jooq.exception.TooManyRowsException; +import org.jooq.impl.DSL; import org.jooq.impl.DefaultRecordMapper; /** @@ -89,6 +90,9 @@ import org.jooq.impl.DefaultRecordMapper; * {@link ResultQuery#fetchSize(int)}, might incur additional database * roundtrips. If this causes problems, {@link ResultQuery#fetchAny()} may be * preferred. + *

    + * Instances can be created using {@link DSL#resultQuery(String)} and overloads, + * or by creating a subtype. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Role.java b/jOOQ/src/main/java/org/jooq/Role.java index d1782cd4e2..4e96e33c21 100644 --- a/jOOQ/src/main/java/org/jooq/Role.java +++ b/jOOQ/src/main/java/org/jooq/Role.java @@ -37,8 +37,12 @@ */ package org.jooq; +import org.jooq.impl.DSL; + /** - * The Role to be used by GRANT statement. + * The Role to be used by the GRANT statement. + *

    + * Instances can be created using {@link DSL#role(Name)} and overloads. * * @author Timur Shaidullin */ diff --git a/jOOQ/src/main/java/org/jooq/Routine.java b/jOOQ/src/main/java/org/jooq/Routine.java index f1db8610f4..f67daccc84 100644 --- a/jOOQ/src/main/java/org/jooq/Routine.java +++ b/jOOQ/src/main/java/org/jooq/Routine.java @@ -81,6 +81,9 @@ import org.jooq.exception.DataAccessException; * Hence, with #852, jOOQ 1.6.8, the distinction between procedures and * functions becomes obsolete. All stored routines are simply referred to as * "Routine". + *

    + * Instances of this type cannot be created directly. They are available from + * generated code. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Row.java b/jOOQ/src/main/java/org/jooq/Row.java index dd7b8d9d60..4dc0c84026 100644 --- a/jOOQ/src/main/java/org/jooq/Row.java +++ b/jOOQ/src/main/java/org/jooq/Row.java @@ -39,12 +39,16 @@ package org.jooq; import java.util.stream.Stream; +import org.jooq.impl.DSL; + /** * A model type for a row value expression. *

    * Note: Not all databases support row value expressions, but many row value * expression operations can be emulated on all databases. See relevant row * value expression method Javadocs for details. + *

    + * Instances can be created using {@link DSL#row(Object...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Row1.java b/jOOQ/src/main/java/org/jooq/Row1.java index a6aaef2b09..4f9ea7a5b0 100644 --- a/jOOQ/src/main/java/org/jooq/Row1.java +++ b/jOOQ/src/main/java/org/jooq/Row1.java @@ -68,6 +68,8 @@ import java.util.Collection; * Note: Not all databases support row value expressions, but many row value * expression operations can be emulated on all databases. See relevant row * value expression method Javadocs for details. + *

    + * Instances can be created using {@link DSL#row(Object...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Row10.java b/jOOQ/src/main/java/org/jooq/Row10.java index ba8cbf116c..a16df347ef 100644 --- a/jOOQ/src/main/java/org/jooq/Row10.java +++ b/jOOQ/src/main/java/org/jooq/Row10.java @@ -68,6 +68,8 @@ import java.util.Collection; * Note: Not all databases support row value expressions, but many row value * expression operations can be emulated on all databases. See relevant row * value expression method Javadocs for details. + *

    + * Instances can be created using {@link DSL#row(Object...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Row11.java b/jOOQ/src/main/java/org/jooq/Row11.java index 7364303f2a..d9b62b9506 100644 --- a/jOOQ/src/main/java/org/jooq/Row11.java +++ b/jOOQ/src/main/java/org/jooq/Row11.java @@ -68,6 +68,8 @@ import java.util.Collection; * Note: Not all databases support row value expressions, but many row value * expression operations can be emulated on all databases. See relevant row * value expression method Javadocs for details. + *

    + * Instances can be created using {@link DSL#row(Object...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Row12.java b/jOOQ/src/main/java/org/jooq/Row12.java index 15b29926d1..168dafca43 100644 --- a/jOOQ/src/main/java/org/jooq/Row12.java +++ b/jOOQ/src/main/java/org/jooq/Row12.java @@ -68,6 +68,8 @@ import java.util.Collection; * Note: Not all databases support row value expressions, but many row value * expression operations can be emulated on all databases. See relevant row * value expression method Javadocs for details. + *

    + * Instances can be created using {@link DSL#row(Object...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Row13.java b/jOOQ/src/main/java/org/jooq/Row13.java index 173c8ee00a..8207eef543 100644 --- a/jOOQ/src/main/java/org/jooq/Row13.java +++ b/jOOQ/src/main/java/org/jooq/Row13.java @@ -68,6 +68,8 @@ import java.util.Collection; * Note: Not all databases support row value expressions, but many row value * expression operations can be emulated on all databases. See relevant row * value expression method Javadocs for details. + *

    + * Instances can be created using {@link DSL#row(Object...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Row14.java b/jOOQ/src/main/java/org/jooq/Row14.java index 01fe1d7a33..2643269ea6 100644 --- a/jOOQ/src/main/java/org/jooq/Row14.java +++ b/jOOQ/src/main/java/org/jooq/Row14.java @@ -68,6 +68,8 @@ import java.util.Collection; * Note: Not all databases support row value expressions, but many row value * expression operations can be emulated on all databases. See relevant row * value expression method Javadocs for details. + *

    + * Instances can be created using {@link DSL#row(Object...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Row15.java b/jOOQ/src/main/java/org/jooq/Row15.java index eb651985da..c472ef913b 100644 --- a/jOOQ/src/main/java/org/jooq/Row15.java +++ b/jOOQ/src/main/java/org/jooq/Row15.java @@ -68,6 +68,8 @@ import java.util.Collection; * Note: Not all databases support row value expressions, but many row value * expression operations can be emulated on all databases. See relevant row * value expression method Javadocs for details. + *

    + * Instances can be created using {@link DSL#row(Object...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Row16.java b/jOOQ/src/main/java/org/jooq/Row16.java index 1e59884b7e..27aa4c35c7 100644 --- a/jOOQ/src/main/java/org/jooq/Row16.java +++ b/jOOQ/src/main/java/org/jooq/Row16.java @@ -68,6 +68,8 @@ import java.util.Collection; * Note: Not all databases support row value expressions, but many row value * expression operations can be emulated on all databases. See relevant row * value expression method Javadocs for details. + *

    + * Instances can be created using {@link DSL#row(Object...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Row17.java b/jOOQ/src/main/java/org/jooq/Row17.java index a2b7f3598d..a16609e581 100644 --- a/jOOQ/src/main/java/org/jooq/Row17.java +++ b/jOOQ/src/main/java/org/jooq/Row17.java @@ -68,6 +68,8 @@ import java.util.Collection; * Note: Not all databases support row value expressions, but many row value * expression operations can be emulated on all databases. See relevant row * value expression method Javadocs for details. + *

    + * Instances can be created using {@link DSL#row(Object...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Row18.java b/jOOQ/src/main/java/org/jooq/Row18.java index d14dc1daa5..590027bfc3 100644 --- a/jOOQ/src/main/java/org/jooq/Row18.java +++ b/jOOQ/src/main/java/org/jooq/Row18.java @@ -68,6 +68,8 @@ import java.util.Collection; * Note: Not all databases support row value expressions, but many row value * expression operations can be emulated on all databases. See relevant row * value expression method Javadocs for details. + *

    + * Instances can be created using {@link DSL#row(Object...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Row19.java b/jOOQ/src/main/java/org/jooq/Row19.java index 662220f97d..6a023914a7 100644 --- a/jOOQ/src/main/java/org/jooq/Row19.java +++ b/jOOQ/src/main/java/org/jooq/Row19.java @@ -68,6 +68,8 @@ import java.util.Collection; * Note: Not all databases support row value expressions, but many row value * expression operations can be emulated on all databases. See relevant row * value expression method Javadocs for details. + *

    + * Instances can be created using {@link DSL#row(Object...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Row2.java b/jOOQ/src/main/java/org/jooq/Row2.java index af725b8f80..d707b86774 100644 --- a/jOOQ/src/main/java/org/jooq/Row2.java +++ b/jOOQ/src/main/java/org/jooq/Row2.java @@ -68,6 +68,8 @@ import java.util.Collection; * Note: Not all databases support row value expressions, but many row value * expression operations can be emulated on all databases. See relevant row * value expression method Javadocs for details. + *

    + * Instances can be created using {@link DSL#row(Object...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Row20.java b/jOOQ/src/main/java/org/jooq/Row20.java index a08ee225f0..24bbbac879 100644 --- a/jOOQ/src/main/java/org/jooq/Row20.java +++ b/jOOQ/src/main/java/org/jooq/Row20.java @@ -68,6 +68,8 @@ import java.util.Collection; * Note: Not all databases support row value expressions, but many row value * expression operations can be emulated on all databases. See relevant row * value expression method Javadocs for details. + *

    + * Instances can be created using {@link DSL#row(Object...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Row21.java b/jOOQ/src/main/java/org/jooq/Row21.java index ebddd4e626..b51e91ceb7 100644 --- a/jOOQ/src/main/java/org/jooq/Row21.java +++ b/jOOQ/src/main/java/org/jooq/Row21.java @@ -68,6 +68,8 @@ import java.util.Collection; * Note: Not all databases support row value expressions, but many row value * expression operations can be emulated on all databases. See relevant row * value expression method Javadocs for details. + *

    + * Instances can be created using {@link DSL#row(Object...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Row22.java b/jOOQ/src/main/java/org/jooq/Row22.java index 286cc7feab..174fb6d1d6 100644 --- a/jOOQ/src/main/java/org/jooq/Row22.java +++ b/jOOQ/src/main/java/org/jooq/Row22.java @@ -68,6 +68,8 @@ import java.util.Collection; * Note: Not all databases support row value expressions, but many row value * expression operations can be emulated on all databases. See relevant row * value expression method Javadocs for details. + *

    + * Instances can be created using {@link DSL#row(Object...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Row3.java b/jOOQ/src/main/java/org/jooq/Row3.java index ba05ddabda..2f611bb9f6 100644 --- a/jOOQ/src/main/java/org/jooq/Row3.java +++ b/jOOQ/src/main/java/org/jooq/Row3.java @@ -68,6 +68,8 @@ import java.util.Collection; * Note: Not all databases support row value expressions, but many row value * expression operations can be emulated on all databases. See relevant row * value expression method Javadocs for details. + *

    + * Instances can be created using {@link DSL#row(Object...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Row4.java b/jOOQ/src/main/java/org/jooq/Row4.java index b8d4187818..7e92201979 100644 --- a/jOOQ/src/main/java/org/jooq/Row4.java +++ b/jOOQ/src/main/java/org/jooq/Row4.java @@ -68,6 +68,8 @@ import java.util.Collection; * Note: Not all databases support row value expressions, but many row value * expression operations can be emulated on all databases. See relevant row * value expression method Javadocs for details. + *

    + * Instances can be created using {@link DSL#row(Object...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Row5.java b/jOOQ/src/main/java/org/jooq/Row5.java index 064bf41422..9b45ef84cc 100644 --- a/jOOQ/src/main/java/org/jooq/Row5.java +++ b/jOOQ/src/main/java/org/jooq/Row5.java @@ -68,6 +68,8 @@ import java.util.Collection; * Note: Not all databases support row value expressions, but many row value * expression operations can be emulated on all databases. See relevant row * value expression method Javadocs for details. + *

    + * Instances can be created using {@link DSL#row(Object...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Row6.java b/jOOQ/src/main/java/org/jooq/Row6.java index 2dec818802..524e0b40f5 100644 --- a/jOOQ/src/main/java/org/jooq/Row6.java +++ b/jOOQ/src/main/java/org/jooq/Row6.java @@ -68,6 +68,8 @@ import java.util.Collection; * Note: Not all databases support row value expressions, but many row value * expression operations can be emulated on all databases. See relevant row * value expression method Javadocs for details. + *

    + * Instances can be created using {@link DSL#row(Object...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Row7.java b/jOOQ/src/main/java/org/jooq/Row7.java index 7558bcb56d..427be649bf 100644 --- a/jOOQ/src/main/java/org/jooq/Row7.java +++ b/jOOQ/src/main/java/org/jooq/Row7.java @@ -68,6 +68,8 @@ import java.util.Collection; * Note: Not all databases support row value expressions, but many row value * expression operations can be emulated on all databases. See relevant row * value expression method Javadocs for details. + *

    + * Instances can be created using {@link DSL#row(Object...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Row8.java b/jOOQ/src/main/java/org/jooq/Row8.java index 3be6bcf5e5..d246fd2755 100644 --- a/jOOQ/src/main/java/org/jooq/Row8.java +++ b/jOOQ/src/main/java/org/jooq/Row8.java @@ -68,6 +68,8 @@ import java.util.Collection; * Note: Not all databases support row value expressions, but many row value * expression operations can be emulated on all databases. See relevant row * value expression method Javadocs for details. + *

    + * Instances can be created using {@link DSL#row(Object...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Row9.java b/jOOQ/src/main/java/org/jooq/Row9.java index 98dd57804b..87f8e38d45 100644 --- a/jOOQ/src/main/java/org/jooq/Row9.java +++ b/jOOQ/src/main/java/org/jooq/Row9.java @@ -68,6 +68,8 @@ import java.util.Collection; * Note: Not all databases support row value expressions, but many row value * expression operations can be emulated on all databases. See relevant row * value expression method Javadocs for details. + *

    + * Instances can be created using {@link DSL#row(Object...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/RowId.java b/jOOQ/src/main/java/org/jooq/RowId.java index 803cba1be4..f2c691b373 100644 --- a/jOOQ/src/main/java/org/jooq/RowId.java +++ b/jOOQ/src/main/java/org/jooq/RowId.java @@ -42,6 +42,8 @@ import java.sql.Types; /** * A data type corresponding to JDBC's {@link Types#ROWID}. + *

    + * Instances can be created using {@link Table#rowid()}. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/RowN.java b/jOOQ/src/main/java/org/jooq/RowN.java index bafacf3391..6df18bf5e1 100644 --- a/jOOQ/src/main/java/org/jooq/RowN.java +++ b/jOOQ/src/main/java/org/jooq/RowN.java @@ -68,6 +68,8 @@ import java.util.Collection; * Note: Not all databases support row value expressions, but many row value * expression operations can be emulated on all databases. See relevant row * value expression method Javadocs for details. + *

    + * Instances can be created using {@link DSL#row(Object...)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/SQL.java b/jOOQ/src/main/java/org/jooq/SQL.java index fb309cbe15..cf8b5ea1c3 100644 --- a/jOOQ/src/main/java/org/jooq/SQL.java +++ b/jOOQ/src/main/java/org/jooq/SQL.java @@ -91,6 +91,8 @@ import org.jooq.impl.DSL; * positions (outside of comments, string literals, quoted name literals) and * substitute the appropriate bind value into the template. * + *

    + * Instances can be created using {@link DSL#sql(String)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Schema.java b/jOOQ/src/main/java/org/jooq/Schema.java index 2974c4b3e4..e71cec9005 100644 --- a/jOOQ/src/main/java/org/jooq/Schema.java +++ b/jOOQ/src/main/java/org/jooq/Schema.java @@ -41,8 +41,12 @@ package org.jooq; import java.util.List; import java.util.stream.Stream; +import org.jooq.impl.DSL; + /** * An object representing a database schema. + *

    + * Instances can be created using {@link DSL#schema(Name)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Select.java b/jOOQ/src/main/java/org/jooq/Select.java index 69104d8ef1..c241a4dd84 100644 --- a/jOOQ/src/main/java/org/jooq/Select.java +++ b/jOOQ/src/main/java/org/jooq/Select.java @@ -62,9 +62,13 @@ import static org.jooq.SQLDialect.SQLITE; import java.util.List; import org.jooq.exception.DataAccessException; +import org.jooq.impl.DSL; /** - * A {@link Query} that can provide a {@link Result} after execution + * A {@link Query} that can provide a {@link Result} after execution. + *

    + * Instances can be created using {@link DSL#select(SelectFieldOrAsterisk...)}, + * or {@link DSLContext#selectQuery()} and overloads. * * @param The record type being returned by this query * @author Lukas Eder diff --git a/jOOQ/src/main/java/org/jooq/SelectField.java b/jOOQ/src/main/java/org/jooq/SelectField.java index ba9403f308..95f2fe2ec8 100644 --- a/jOOQ/src/main/java/org/jooq/SelectField.java +++ b/jOOQ/src/main/java/org/jooq/SelectField.java @@ -41,6 +41,8 @@ package org.jooq; /** * A QueryPart to be used exclusively in SELECT * clauses. + *

    + * Instances of this type cannot be created directly, only of its subtypes. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/SelectFieldOrAsterisk.java b/jOOQ/src/main/java/org/jooq/SelectFieldOrAsterisk.java index e5ca3897ac..79ff397c76 100644 --- a/jOOQ/src/main/java/org/jooq/SelectFieldOrAsterisk.java +++ b/jOOQ/src/main/java/org/jooq/SelectFieldOrAsterisk.java @@ -41,6 +41,8 @@ package org.jooq; /** * A QueryPart to be used exclusively in SELECT * clauses. + *

    + * Instances of this type cannot be created directly, only of its subtypes. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/SelectQuery.java b/jOOQ/src/main/java/org/jooq/SelectQuery.java index 02c5b81804..91a83d0b9f 100644 --- a/jOOQ/src/main/java/org/jooq/SelectQuery.java +++ b/jOOQ/src/main/java/org/jooq/SelectQuery.java @@ -74,7 +74,9 @@ import java.util.Collection; import org.jooq.exception.DataAccessException; /** - * A query for data selection + * A query for data selection. + *

    + * Instances can be created using {@link DSLContext#selectQuery()} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Sequence.java b/jOOQ/src/main/java/org/jooq/Sequence.java index 7f03aafd1f..51fd6be756 100644 --- a/jOOQ/src/main/java/org/jooq/Sequence.java +++ b/jOOQ/src/main/java/org/jooq/Sequence.java @@ -52,8 +52,12 @@ import static org.jooq.SQLDialect.POSTGRES; // ... // ... +import org.jooq.impl.DSL; + /** * A type representing sequences in databases that support this. + *

    + * Instances can be created using {@link DSL#sequence(Name)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/SortField.java b/jOOQ/src/main/java/org/jooq/SortField.java index c2d2524778..43419ecdb3 100644 --- a/jOOQ/src/main/java/org/jooq/SortField.java +++ b/jOOQ/src/main/java/org/jooq/SortField.java @@ -39,7 +39,10 @@ package org.jooq; /** - * A wrapper for a {@link Field} and a {@link SortField} + * A wrapper for a {@link Field} and a {@link SortField}. + *

    + * Instances can be created using {@link Field#asc()}, {@link Field#desc()} and + * related methods. * * @param The field type * @author Lukas Eder diff --git a/jOOQ/src/main/java/org/jooq/Statement.java b/jOOQ/src/main/java/org/jooq/Statement.java index 4857b9c30a..9829760858 100644 --- a/jOOQ/src/main/java/org/jooq/Statement.java +++ b/jOOQ/src/main/java/org/jooq/Statement.java @@ -40,6 +40,8 @@ package org.jooq; /** * A statement that can be placed inside of a {@link Block}, but not executed on * its own. + *

    + * Instances of this type cannot be created directly, only of its subtypes. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/StoreQuery.java b/jOOQ/src/main/java/org/jooq/StoreQuery.java index 6a759f5940..52aa71ad4b 100644 --- a/jOOQ/src/main/java/org/jooq/StoreQuery.java +++ b/jOOQ/src/main/java/org/jooq/StoreQuery.java @@ -43,6 +43,8 @@ import java.util.Map; /** * A query storing objects to the database. This is either an insert or an * update query. + *

    + * Instances of this type cannot be created directly, only of its subtypes. * * @param The record type of the table being modified * @author Lukas Eder diff --git a/jOOQ/src/main/java/org/jooq/Table.java b/jOOQ/src/main/java/org/jooq/Table.java index 651a8c6538..2c9da908c6 100644 --- a/jOOQ/src/main/java/org/jooq/Table.java +++ b/jOOQ/src/main/java/org/jooq/Table.java @@ -75,7 +75,9 @@ import org.jooq.conf.Settings; import org.jooq.impl.DSL; /** - * A table to be used in queries + * A table to be used in queries. + *

    + * Instances can be created using {@link DSL#table(Name)} and overloads. * * @param The record type associated with this table * @author Lukas Eder diff --git a/jOOQ/src/main/java/org/jooq/TableField.java b/jOOQ/src/main/java/org/jooq/TableField.java index b4875875f6..b133a40740 100644 --- a/jOOQ/src/main/java/org/jooq/TableField.java +++ b/jOOQ/src/main/java/org/jooq/TableField.java @@ -39,7 +39,10 @@ package org.jooq; /** - * A field contained in a table + * A field contained in a table. + *

    + * Instances of this type cannot be created directly. They are available from + * generated code. * * @param The record type * @param The field type diff --git a/jOOQ/src/main/java/org/jooq/TableLike.java b/jOOQ/src/main/java/org/jooq/TableLike.java index 05bd4b248b..888f8e7893 100644 --- a/jOOQ/src/main/java/org/jooq/TableLike.java +++ b/jOOQ/src/main/java/org/jooq/TableLike.java @@ -42,7 +42,9 @@ import java.util.function.Function; import java.util.stream.Stream; /** - * An object that can behave like a table (a table-like object) + * An object that can behave like a table (a table-like object). + *

    + * Instances of this type cannot be created directly, only of its subtypes. * * @param The record type * @author Lukas Eder diff --git a/jOOQ/src/main/java/org/jooq/True.java b/jOOQ/src/main/java/org/jooq/True.java index bf1d25a312..f943fbe223 100644 --- a/jOOQ/src/main/java/org/jooq/True.java +++ b/jOOQ/src/main/java/org/jooq/True.java @@ -37,8 +37,12 @@ */ package org.jooq; +import org.jooq.impl.DSL; + /** * A predicate that always yields true. + *

    + * Instances can be created using {@link DSL#trueCondition()}. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/Truncate.java b/jOOQ/src/main/java/org/jooq/Truncate.java index 46da78100c..14131009dd 100644 --- a/jOOQ/src/main/java/org/jooq/Truncate.java +++ b/jOOQ/src/main/java/org/jooq/Truncate.java @@ -37,9 +37,13 @@ */ package org.jooq; +import org.jooq.impl.DSL; /** * A {@link Query} that can truncate a table in the database. + *

    + * Instances can be created using {@link DSL#truncate(Table)}, or + * {@link DSLContext#truncate(Table)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/UDT.java b/jOOQ/src/main/java/org/jooq/UDT.java index 7b2b1a0afa..6b4c262563 100644 --- a/jOOQ/src/main/java/org/jooq/UDT.java +++ b/jOOQ/src/main/java/org/jooq/UDT.java @@ -40,7 +40,10 @@ package org.jooq; import java.util.stream.Stream; /** - * UDT definition + * UDT definition. + *

    + * Instances of this type cannot be created directly. They are available from + * generated code. * * @param The record type * @author Lukas Eder diff --git a/jOOQ/src/main/java/org/jooq/UDTField.java b/jOOQ/src/main/java/org/jooq/UDTField.java index e1c0813303..37143d0171 100644 --- a/jOOQ/src/main/java/org/jooq/UDTField.java +++ b/jOOQ/src/main/java/org/jooq/UDTField.java @@ -39,7 +39,10 @@ package org.jooq; /** - * A field contained in a UDT + * A field contained in a UDT. + *

    + * Instances of this type cannot be created directly. They are available from + * generated code. * * @param The record type * @param The field type diff --git a/jOOQ/src/main/java/org/jooq/UniqueKey.java b/jOOQ/src/main/java/org/jooq/UniqueKey.java index b3f7210ca2..7f51003686 100644 --- a/jOOQ/src/main/java/org/jooq/UniqueKey.java +++ b/jOOQ/src/main/java/org/jooq/UniqueKey.java @@ -41,7 +41,10 @@ import java.util.List; /** * A UniqueKey is an object representing a UNIQUE KEY - * or a PRIMARY KEY. It can be referenced by a {@link ForeignKey} + * or a PRIMARY KEY. It can be referenced by a {@link ForeignKey}. + *

    + * Instances of this type cannot be created directly. They are available from + * generated code. * * @param The KEY's owner table record * @author Lukas Eder diff --git a/jOOQ/src/main/java/org/jooq/Update.java b/jOOQ/src/main/java/org/jooq/Update.java index bc4e481c9c..897bb2b1a7 100644 --- a/jOOQ/src/main/java/org/jooq/Update.java +++ b/jOOQ/src/main/java/org/jooq/Update.java @@ -37,9 +37,13 @@ */ package org.jooq; +import org.jooq.impl.DSL; /** * A {@link Query} that can update data in the database. + *

    + * Instances can be created using {@link DSL#update(Table)}, or + * {@link DSLContext#updateQuery(Table)} and overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/UpdateQuery.java b/jOOQ/src/main/java/org/jooq/UpdateQuery.java index d78a9a3119..31d752aa89 100644 --- a/jOOQ/src/main/java/org/jooq/UpdateQuery.java +++ b/jOOQ/src/main/java/org/jooq/UpdateQuery.java @@ -53,7 +53,10 @@ import static org.jooq.SQLDialect.POSTGRES; import java.util.Collection; /** - * A query for data updating + * A query for data updating. + *

    + * Instances can be created using {@link DSLContext#updateQuery(Table)} and + * overloads. * * @param The record type of the table being updated * @author Lukas Eder diff --git a/jOOQ/src/main/java/org/jooq/User.java b/jOOQ/src/main/java/org/jooq/User.java index 503305b231..1c0d6d71b7 100644 --- a/jOOQ/src/main/java/org/jooq/User.java +++ b/jOOQ/src/main/java/org/jooq/User.java @@ -37,8 +37,12 @@ */ package org.jooq; +import org.jooq.impl.DSL; + /** - * The User to be used by GRANT statement. + * The User to be used by the GRANT statement. + *

    + * Instances can be created using {@link DSL#user(Name)} and overloads. * * @author Timur Shaidullin */ diff --git a/jOOQ/src/main/java/org/jooq/Variable.java b/jOOQ/src/main/java/org/jooq/Variable.java index 3ca5dc9deb..6bb5e944bb 100644 --- a/jOOQ/src/main/java/org/jooq/Variable.java +++ b/jOOQ/src/main/java/org/jooq/Variable.java @@ -56,6 +56,10 @@ package org.jooq; + + + + diff --git a/jOOQ/src/main/java/org/jooq/WindowDefinition.java b/jOOQ/src/main/java/org/jooq/WindowDefinition.java index 555fa6ef25..a812c5f5e0 100644 --- a/jOOQ/src/main/java/org/jooq/WindowDefinition.java +++ b/jOOQ/src/main/java/org/jooq/WindowDefinition.java @@ -50,13 +50,16 @@ package org.jooq; *

    * The WINDOW clause is only natively supported by *

    *

    * If your database supports window functions, but not the WINDOW * clause, jOOQ will inline window definitions into their respective window * functions. + *

    + * Instances can be created using {@link Name#as(WindowSpecification)} and + * overloads. * * @author Lukas Eder */ diff --git a/jOOQ/src/main/java/org/jooq/WindowSpecification.java b/jOOQ/src/main/java/org/jooq/WindowSpecification.java index 18ea95a026..134a5b53d8 100644 --- a/jOOQ/src/main/java/org/jooq/WindowSpecification.java +++ b/jOOQ/src/main/java/org/jooq/WindowSpecification.java @@ -37,6 +37,8 @@ */ package org.jooq; +import org.jooq.impl.DSL; + /** * A window specification. *

    @@ -52,6 +54,10 @@ package org.jooq; * .rowsBetweenUnboundedPreceding() * .andCurrentRow(); * + *

    + * Instances can be created using {@link DSL#partitionBy(Field...)}, + * {@link DSL#orderBy(OrderField...)}, and overloads as well as rows / range / + * groups related methods in {@link DSL}. * * @author Lukas Eder */