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

[jOOQ/jOOQ#13225] Add Javadoc to all XJC-generated withers and setters

Browse Source 
of boolean types
This commit is contained in:
Lukas Eder 2024-01-12 11:55:42 +01:00
parent ba636bdd1e
commit e6abaf2c7b
13 changed files with 2852 additions and 314 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
jOOQ-meta/src/main/java/org/jooq/meta/jaxb/CatalogMappingType.java
View File

@ -89,7 +89,7 @@ public class CatalogMappingType implements Serializable, XMLAppendable
}
/**
* Sets the value of the outputCatalogToDefault property.
* See also {@link Database#isOutputCatalogToDefault()}
*
* @param value
* allowed object is
@ -129,6 +129,10 @@ public class CatalogMappingType implements Serializable, XMLAppendable
return this;
}
/**
* See also {@link Database#isOutputCatalogToDefault()}
*
*/
public CatalogMappingType withOutputCatalogToDefault(Boolean value) {
setOutputCatalogToDefault(value);
return this;

12
jOOQ-meta/src/main/java/org/jooq/meta/jaxb/CommentType.java
View File

@ -86,7 +86,7 @@ public class CommentType implements Serializable, XMLAppendable
}
/**
* Sets the value of the deprecated property.
* Whether the comment is a deprecation notice.
*
* @param value
* allowed object is
@ -110,7 +110,7 @@ public class CommentType implements Serializable, XMLAppendable
}
/**
* Sets the value of the includeSchemaComment property.
* Whether the schema comment (if available) should be included and prepended to the message.
*
* @param value
* allowed object is
@ -139,11 +139,19 @@ public class CommentType implements Serializable, XMLAppendable
return this;
}
/**
* Whether the comment is a deprecation notice.
*
*/
public CommentType withDeprecated(Boolean value) {
setDeprecated(value);
return this;
}
/**
* Whether the schema comment (if available) should be included and prepended to the message.
*
*/
public CommentType withIncludeSchemaComment(Boolean value) {
setIncludeSchemaComment(value);
return this;

60
jOOQ-meta/src/main/java/org/jooq/meta/jaxb/CustomType.java
View File

@ -142,7 +142,7 @@ public class CustomType implements Serializable, XMLAppendable
}
/**
* Sets the value of the auditInsertTimestamp property.
* @deprecated Use ForcedType only
*
* @param value
* allowed object is
@ -168,7 +168,7 @@ public class CustomType implements Serializable, XMLAppendable
}
/**
* Sets the value of the auditInsertUser property.
* @deprecated Use ForcedType only
*
* @param value
* allowed object is
@ -194,7 +194,7 @@ public class CustomType implements Serializable, XMLAppendable
}
/**
* Sets the value of the auditUpdateTimestamp property.
* @deprecated Use ForcedType only
*
* @param value
* allowed object is
@ -220,7 +220,7 @@ public class CustomType implements Serializable, XMLAppendable
}
/**
* Sets the value of the auditUpdateUser property.
* @deprecated Use ForcedType only
*
* @param value
* allowed object is
@ -264,7 +264,7 @@ public class CustomType implements Serializable, XMLAppendable
}
/**
* Sets the value of the genericConverter property.
* @deprecated Use ForcedType only
*
* @param value
* allowed object is
@ -290,7 +290,7 @@ public class CustomType implements Serializable, XMLAppendable
}
/**
* Sets the value of the autoConverter property.
* @deprecated Use ForcedType only
*
* @param value
* allowed object is
@ -316,7 +316,7 @@ public class CustomType implements Serializable, XMLAppendable
}
/**
* Sets the value of the enumConverter property.
* @deprecated Use ForcedType only
*
* @param value
* allowed object is
@ -342,7 +342,7 @@ public class CustomType implements Serializable, XMLAppendable
}
/**
* Sets the value of the xmlConverter property.
* @deprecated Use ForcedType only
*
* @param value
* allowed object is
@ -368,7 +368,7 @@ public class CustomType implements Serializable, XMLAppendable
}
/**
* Sets the value of the jsonConverter property.
* @deprecated Use ForcedType only
*
* @param value
* allowed object is
@ -430,7 +430,7 @@ public class CustomType implements Serializable, XMLAppendable
}
/**
* Sets the value of the genericBinding property.
* @deprecated Use ForcedType only
*
* @param value
* allowed object is
@ -482,21 +482,37 @@ public class CustomType implements Serializable, XMLAppendable
return this;
}
/**
* @deprecated Use ForcedType only
*
*/
public CustomType withAuditInsertTimestamp(Boolean value) {
setAuditInsertTimestamp(value);
return this;
}
/**
* @deprecated Use ForcedType only
*
*/
public CustomType withAuditInsertUser(Boolean value) {
setAuditInsertUser(value);
return this;
}
/**
* @deprecated Use ForcedType only
*
*/
public CustomType withAuditUpdateTimestamp(Boolean value) {
setAuditUpdateTimestamp(value);
return this;
}
/**
* @deprecated Use ForcedType only
*
*/
public CustomType withAuditUpdateUser(Boolean value) {
setAuditUpdateUser(value);
return this;
@ -512,26 +528,46 @@ public class CustomType implements Serializable, XMLAppendable
return this;
}
/**
* @deprecated Use ForcedType only
*
*/
public CustomType withGenericConverter(Boolean value) {
setGenericConverter(value);
return this;
}
/**
* @deprecated Use ForcedType only
*
*/
public CustomType withAutoConverter(Boolean value) {
setAutoConverter(value);
return this;
}
/**
* @deprecated Use ForcedType only
*
*/
public CustomType withEnumConverter(Boolean value) {
setEnumConverter(value);
return this;
}
/**
* @deprecated Use ForcedType only
*
*/
public CustomType withXmlConverter(Boolean value) {
setXmlConverter(value);
return this;
}
/**
* @deprecated Use ForcedType only
*
*/
public CustomType withJsonConverter(Boolean value) {
setJsonConverter(value);
return this;
@ -557,6 +593,10 @@ public class CustomType implements Serializable, XMLAppendable
return this;
}
/**
* @deprecated Use ForcedType only
*
*/
public CustomType withGenericBinding(Boolean value) {
setGenericBinding(value);
return this;

308
jOOQ-meta/src/main/java/org/jooq/meta/jaxb/Database.java
View File

@ -364,7 +364,7 @@ public class Database implements Serializable, XMLAppendable
}
/**
* Sets the value of the regexMatchesPartialQualification property.
* Whether regular expressions that match qualified object names also match partial qualifications (e.g. `table\.column` matches `schema.table.column`) or only full and/or no qualifications (e.g. `schema\.table\.column` and `column` match `schema.table.column`)
*
* @param value
* allowed object is
@ -388,7 +388,7 @@ public class Database implements Serializable, XMLAppendable
}
/**
* Sets the value of the sqlMatchesPartialQualification property.
* Whether SQL queries that match qualified object names also match partial qualifications (e.g. `table\.column` matches `schema.table.column`) or only full and/or no qualifications (e.g. `schema\.table\.column` and `column` match `schema.table.column`)
*
* @param value
* allowed object is
@ -544,7 +544,7 @@ public class Database implements Serializable, XMLAppendable
}
/**
* Sets the value of the includeExcludeColumns property.
* This flag indicates whether include / exclude patterns should also match columns within tables.
*
* @param value
* allowed object is
@ -568,7 +568,7 @@ public class Database implements Serializable, XMLAppendable
}
/**
* Sets the value of the includeExcludePackageRoutines property.
* This flag indicates whether include / exclude patterns should also match routines within packages.
*
* @param value
* allowed object is
@ -592,7 +592,7 @@ public class Database implements Serializable, XMLAppendable
}
/**
* Sets the value of the includeTables property.
* This flag indicates whether tables should be included in output produced by this database
*
* @param value
* allowed object is
@ -616,7 +616,7 @@ public class Database implements Serializable, XMLAppendable
}
/**
* Sets the value of the includeEmbeddables property.
* This flag indicates whether embeddable types should be included in output produced by this database
*
* @param value
* allowed object is
@ -640,7 +640,7 @@ public class Database implements Serializable, XMLAppendable
}
/**
* Sets the value of the includeRoutines property.
* This flag indicates whether routines should be included in output produced by this database
*
* @param value
* allowed object is
@ -664,7 +664,7 @@ public class Database implements Serializable, XMLAppendable
}
/**
* Sets the value of the includeTriggerRoutines property.
* This flag indicates whether trigger implementation routines should be included in output produced by this database (e.g. in PostgreSQL)
*
* @param value
* allowed object is
@ -688,7 +688,7 @@ public class Database implements Serializable, XMLAppendable
}
/**
* Sets the value of the includePackages property.
* This flag indicates whether packages should be included in output produced by this database
*
* @param value
* allowed object is
@ -712,7 +712,7 @@ public class Database implements Serializable, XMLAppendable
}
/**
* Sets the value of the includePackageRoutines property.
* This flag indicates whether routines contained in packages should be included in output produced by this database
*
* @param value
* allowed object is
@ -736,7 +736,7 @@ public class Database implements Serializable, XMLAppendable
}
/**
* Sets the value of the includePackageUDTs property.
* This flag indicates whether UDTs contained in packages should be included in output produced by this database
*
* @param value
* allowed object is
@ -760,7 +760,7 @@ public class Database implements Serializable, XMLAppendable
}
/**
* Sets the value of the includePackageConstants property.
* This flag indicates whether constants contained in packages should be included in output produced by this database
*
* @param value
* allowed object is
@ -784,7 +784,7 @@ public class Database implements Serializable, XMLAppendable
}
/**
* Sets the value of the includeXMLSchemaCollections property.
* This flag indicates whether XML schema collections should be included in output produced by this database
*
* @param value
* allowed object is
@ -808,7 +808,7 @@ public class Database implements Serializable, XMLAppendable
}
/**
* Sets the value of the includeUDTs property.
* This flag indicates whether udts should be included in output produced by this database
*
* @param value
* allowed object is
@ -832,7 +832,7 @@ public class Database implements Serializable, XMLAppendable
}
/**
* Sets the value of the includeDomains property.
* This flag indicates whether domains should be included in output produced by this database
*
* @param value
* allowed object is
@ -858,7 +858,9 @@ public class Database implements Serializable, XMLAppendable
}
/**
* Sets the value of the includeTriggers property.
* This flag indicates whether triggers should be included in output produced by this database.
* <p>
* This feature is available in the commercial distribution only.
*
* @param value
* allowed object is
@ -882,7 +884,7 @@ public class Database implements Serializable, XMLAppendable
}
/**
* Sets the value of the includeSequences property.
* This flag indicates whether sequences should be included in output produced by this database
*
* @param value
* allowed object is
@ -906,7 +908,7 @@ public class Database implements Serializable, XMLAppendable
}
/**
* Sets the value of the includeIndexes property.
* This flag indicates whether indexes should be included in output produced by this database
*
* @param value
* allowed object is
@ -930,7 +932,7 @@ public class Database implements Serializable, XMLAppendable
}
/**
* Sets the value of the includePrimaryKeys property.
* This flag indicates whether primary keys should be included in output produced by this database
*
* @param value
* allowed object is
@ -954,7 +956,7 @@ public class Database implements Serializable, XMLAppendable
}
/**
* Sets the value of the includeUniqueKeys property.
* This flag indicates whether unique keys should be included in output produced by this database
*
* @param value
* allowed object is
@ -978,7 +980,7 @@ public class Database implements Serializable, XMLAppendable
}
/**
* Sets the value of the includeForeignKeys property.
* This flag indicates whether foreign keys should be included in output produced by this database
*
* @param value
* allowed object is
@ -1002,7 +1004,7 @@ public class Database implements Serializable, XMLAppendable
}
/**
* Sets the value of the includeCheckConstraints property.
* This flag indicates whether check constraints should be included in output produced by this database
*
* @param value
* allowed object is
@ -1026,7 +1028,7 @@ public class Database implements Serializable, XMLAppendable
}
/**
* Sets the value of the includeSystemTables property.
* This flag indicates whether system tables should be included in output produced by this database
*
* @param value
* allowed object is
@ -1050,7 +1052,7 @@ public class Database implements Serializable, XMLAppendable
}
/**
* Sets the value of the includeSystemIndexes property.
* This flag indicates whether system generated indexes should be included in output produced by this database
*
* @param value
* allowed object is
@ -1074,7 +1076,7 @@ public class Database implements Serializable, XMLAppendable
}
/**
* Sets the value of the includeSystemCheckConstraints property.
* This flag indicates whether system generated check constraints should be included in output produced by this database
*
* @param value
* allowed object is
@ -1098,7 +1100,7 @@ public class Database implements Serializable, XMLAppendable
}
/**
* Sets the value of the includeSystemSequences property.
* This flag indicates whether system generated sequences should be included in output produced by this database
*
* @param value
* allowed object is
@ -1122,7 +1124,7 @@ public class Database implements Serializable, XMLAppendable
}
/**
* Sets the value of the includeSystemUDTs property.
* This flag indicates whether system generated UDTs should be included in output produced by this database
*
* @param value
* allowed object is
@ -1146,7 +1148,7 @@ public class Database implements Serializable, XMLAppendable
}
/**
* Sets the value of the includeInvisibleColumns property.
* This flag indicates whether invisible columns should be included in output produced by this database
*
* @param value
* allowed object is
@ -1330,7 +1332,7 @@ public class Database implements Serializable, XMLAppendable
}
/**
* Sets the value of the dateAsTimestamp property.
* Generate {@link java.sql.Timestamp} fields for DATE columns. This is particularly useful for Oracle databases
*
* @param value
* allowed object is
@ -1363,7 +1365,15 @@ public class Database implements Serializable, XMLAppendable
}
/**
* Sets the value of the ignoreProcedureReturnValues property.
* Ignore procedure return values in Transact-SQL generated code.
* <p>
* In jOOQ 3.6.0, #4106 was implemented to support Transact-SQL's
* optional return values from stored procedures. This turns all procedures
* into Routine<Integer> (instead of Routine<Void>). For backwards-
* compatibility reasons, users can suppress this change in jOOQ 3.x
* <p>
* @deprecated This feature is deprecated as of jOOQ 3.6.0 and will be removed again in
* jOOQ 4.0.
*
* @param value
* allowed object is
@ -1388,7 +1398,7 @@ public class Database implements Serializable, XMLAppendable
}
/**
* Sets the value of the unsignedTypes property.
* Generate jOOU data types for your unsigned data types, which are not natively supported in Java
*
* @param value
* allowed object is
@ -1412,7 +1422,7 @@ public class Database implements Serializable, XMLAppendable
}
/**
* Sets the value of the integerDisplayWidths property.
* Include display width in type declaration. In some RDBMS (e.g. MariaDB, MySQL), fixed width integer types are optionally accompanied by a display width. This is sometimes abused to model BOOLEAN types via TINYINT(1). This flag allows for including that display width in the type declaration exposed by jOOQ-meta code, as if it were a numeric precision.
*
* @param value
* allowed object is
@ -1487,7 +1497,8 @@ public class Database implements Serializable, XMLAppendable
}
/**
* Sets the value of the outputCatalogToDefault property.
* A flag to indicate that the outputCatalog should be the "default" catalog,
* which generates catalog-less, unqualified tables, procedures, etc.
*
* @param value
* allowed object is
@ -1562,7 +1573,8 @@ public class Database implements Serializable, XMLAppendable
}
/**
* Sets the value of the outputSchemaToDefault property.
* A flag to indicate that the outputSchema should be the "default" schema,
* which generates schema-less, unqualified tables, procedures, etc.
*
* @param value
* allowed object is
@ -1750,7 +1762,9 @@ public class Database implements Serializable, XMLAppendable
}
/**
* Sets the value of the readonlyIdentities property.
* Whether identity columns should expose {@link org.jooq.DataType#readonly()} behaviour.
* <p>
* This feature is available in the commercial distribution only.
*
* @param value
* allowed object is
@ -1776,7 +1790,9 @@ public class Database implements Serializable, XMLAppendable
}
/**
* Sets the value of the readonlyComputedColumns property.
* Whether computed columns should expose {@link org.jooq.DataType#readonly()} behaviour.
* <p>
* This feature is available in the commercial distribution only.
*
* @param value
* allowed object is
@ -1802,7 +1818,9 @@ public class Database implements Serializable, XMLAppendable
}
/**
* Sets the value of the readonlyNonUpdatableColumns property.
* Whether columns that are known not to be updatable (e.g. in views) should expose {@link org.jooq.DataType#readonly()} behaviour.
* <p>
* This feature is available in the commercial distribution only.
*
* @param value
* allowed object is
@ -1826,7 +1844,7 @@ public class Database implements Serializable, XMLAppendable
}
/**
* Sets the value of the forcedTypesForBuiltinDataTypeExtensions property.
* Enable some default forced type configurations for built in data type extensions, such as the ones from the jooq-postgres-extensions module.
*
* @param value
* allowed object is
@ -1852,7 +1870,9 @@ public class Database implements Serializable, XMLAppendable
}
/**
* Sets the value of the forcedTypesForXMLSchemaCollections property.
* Enable some default forced type configurations for XML schema collections, mapping them to JAXB annotated types using the {@link org.jooq.impl.XMLtoJAXBConverter}
* <p>
* This feature is available in the commercial distribution only.
*
* @param value
* allowed object is
@ -1876,7 +1896,7 @@ public class Database implements Serializable, XMLAppendable
}
/**
* Sets the value of the forceIntegerTypesOnZeroScaleDecimals property.
* Historically, zero-scale decimal types are generated as their most appropriate, corresponding integer type (e.g. NUMBER(2, 0) and less: Byte). This allows for turning off this feature. In case of conflict between this rule and actual {@link #getForcedTypes()}, the latter will win.
*
* @param value
* allowed object is
@ -1908,7 +1928,15 @@ public class Database implements Serializable, XMLAppendable
}
/**
* Sets the value of the tableValuedFunctions property.
* Whether table valued functions should be reported as tables.
* <p>
* If this is deactivated, such functions are not generated as tables, but
* as ordinary routines. This is particularly useful for backwards-
* compatibility between jOOQ 3.8 and previous versions, when using TABLE
* and VARRAY types in Oracle.
* <p>
* While this flag defaults to true for most databases, it defaults to false
* for Oracle.
*
* @param value
* allowed object is
@ -1932,7 +1960,7 @@ public class Database implements Serializable, XMLAppendable
}
/**
* Sets the value of the oracleUseDBAViews property.
* Specify whether to use the Oracle DBA_XYZ views instead of the ALL_XYZ views.
*
* @param value
* allowed object is
@ -2192,11 +2220,19 @@ public class Database implements Serializable, XMLAppendable
return this;
}
/**
* Whether regular expressions that match qualified object names also match partial qualifications (e.g. `table\.column` matches `schema.table.column`) or only full and/or no qualifications (e.g. `schema\.table\.column` and `column` match `schema.table.column`)
*
*/
public Database withRegexMatchesPartialQualification(Boolean value) {
setRegexMatchesPartialQualification(value);
return this;
}
/**
* Whether SQL queries that match qualified object names also match partial qualifications (e.g. `table\.column` matches `schema.table.column`) or only full and/or no qualifications (e.g. `schema\.table\.column` and `column` match `schema.table.column`)
*
*/
public Database withSqlMatchesPartialQualification(Boolean value) {
setSqlMatchesPartialQualification(value);
return this;
@ -2272,131 +2308,237 @@ public class Database implements Serializable, XMLAppendable
return this;
}
/**
* This flag indicates whether include / exclude patterns should also match columns within tables.
*
*/
public Database withIncludeExcludeColumns(Boolean value) {
setIncludeExcludeColumns(value);
return this;
}
/**
* This flag indicates whether include / exclude patterns should also match routines within packages.
*
*/
public Database withIncludeExcludePackageRoutines(Boolean value) {
setIncludeExcludePackageRoutines(value);
return this;
}
/**
* This flag indicates whether tables should be included in output produced by this database
*
*/
public Database withIncludeTables(Boolean value) {
setIncludeTables(value);
return this;
}
/**
* This flag indicates whether embeddable types should be included in output produced by this database
*
*/
public Database withIncludeEmbeddables(Boolean value) {
setIncludeEmbeddables(value);
return this;
}
/**
* This flag indicates whether routines should be included in output produced by this database
*
*/
public Database withIncludeRoutines(Boolean value) {
setIncludeRoutines(value);
return this;
}
/**
* This flag indicates whether trigger implementation routines should be included in output produced by this database (e.g. in PostgreSQL)
*
*/
public Database withIncludeTriggerRoutines(Boolean value) {
setIncludeTriggerRoutines(value);
return this;
}
/**
* This flag indicates whether packages should be included in output produced by this database
*
*/
public Database withIncludePackages(Boolean value) {
setIncludePackages(value);
return this;
}
/**
* This flag indicates whether routines contained in packages should be included in output produced by this database
*
*/
public Database withIncludePackageRoutines(Boolean value) {
setIncludePackageRoutines(value);
return this;
}
/**
* This flag indicates whether UDTs contained in packages should be included in output produced by this database
*
*/
public Database withIncludePackageUDTs(Boolean value) {
setIncludePackageUDTs(value);
return this;
}
/**
* This flag indicates whether constants contained in packages should be included in output produced by this database
*
*/
public Database withIncludePackageConstants(Boolean value) {
setIncludePackageConstants(value);
return this;
}
/**
* This flag indicates whether XML schema collections should be included in output produced by this database
*
*/
public Database withIncludeXMLSchemaCollections(Boolean value) {
setIncludeXMLSchemaCollections(value);
return this;
}
/**
* This flag indicates whether udts should be included in output produced by this database
*
*/
public Database withIncludeUDTs(Boolean value) {
setIncludeUDTs(value);
return this;
}
/**
* This flag indicates whether domains should be included in output produced by this database
*
*/
public Database withIncludeDomains(Boolean value) {
setIncludeDomains(value);
return this;
}
/**
* This flag indicates whether triggers should be included in output produced by this database.
* <p>
* This feature is available in the commercial distribution only.
*
*/
public Database withIncludeTriggers(Boolean value) {
setIncludeTriggers(value);
return this;
}
/**
* This flag indicates whether sequences should be included in output produced by this database
*
*/
public Database withIncludeSequences(Boolean value) {
setIncludeSequences(value);
return this;
}
/**
* This flag indicates whether indexes should be included in output produced by this database
*
*/
public Database withIncludeIndexes(Boolean value) {
setIncludeIndexes(value);
return this;
}
/**
* This flag indicates whether primary keys should be included in output produced by this database
*
*/
public Database withIncludePrimaryKeys(Boolean value) {
setIncludePrimaryKeys(value);
return this;
}
/**
* This flag indicates whether unique keys should be included in output produced by this database
*
*/
public Database withIncludeUniqueKeys(Boolean value) {
setIncludeUniqueKeys(value);
return this;
}
/**
* This flag indicates whether foreign keys should be included in output produced by this database
*
*/
public Database withIncludeForeignKeys(Boolean value) {
setIncludeForeignKeys(value);
return this;
}
/**
* This flag indicates whether check constraints should be included in output produced by this database
*
*/
public Database withIncludeCheckConstraints(Boolean value) {
setIncludeCheckConstraints(value);
return this;
}
/**
* This flag indicates whether system tables should be included in output produced by this database
*
*/
public Database withIncludeSystemTables(Boolean value) {
setIncludeSystemTables(value);
return this;
}
/**
* This flag indicates whether system generated indexes should be included in output produced by this database
*
*/
public Database withIncludeSystemIndexes(Boolean value) {
setIncludeSystemIndexes(value);
return this;
}
/**
* This flag indicates whether system generated check constraints should be included in output produced by this database
*
*/
public Database withIncludeSystemCheckConstraints(Boolean value) {
setIncludeSystemCheckConstraints(value);
return this;
}
/**
* This flag indicates whether system generated sequences should be included in output produced by this database
*
*/
public Database withIncludeSystemSequences(Boolean value) {
setIncludeSystemSequences(value);
return this;
}
/**
* This flag indicates whether system generated UDTs should be included in output produced by this database
*
*/
public Database withIncludeSystemUDTs(Boolean value) {
setIncludeSystemUDTs(value);
return this;
}
/**
* This flag indicates whether invisible columns should be included in output produced by this database
*
*/
public Database withIncludeInvisibleColumns(Boolean value) {
setIncludeInvisibleColumns(value);
return this;
@ -2488,21 +2630,45 @@ public class Database implements Serializable, XMLAppendable
return this;
}
/**
* Generate {@link java.sql.Timestamp} fields for DATE columns. This is particularly useful for Oracle databases
*
*/
public Database withDateAsTimestamp(Boolean value) {
setDateAsTimestamp(value);
return this;
}
/**
* Ignore procedure return values in Transact-SQL generated code.
* <p>
* In jOOQ 3.6.0, #4106 was implemented to support Transact-SQL's
* optional return values from stored procedures. This turns all procedures
* into Routine<Integer> (instead of Routine<Void>). For backwards-
* compatibility reasons, users can suppress this change in jOOQ 3.x
* <p>
* @deprecated This feature is deprecated as of jOOQ 3.6.0 and will be removed again in
* jOOQ 4.0.
*
*/
public Database withIgnoreProcedureReturnValues(Boolean value) {
setIgnoreProcedureReturnValues(value);
return this;
}
/**
* Generate jOOU data types for your unsigned data types, which are not natively supported in Java
*
*/
public Database withUnsignedTypes(Boolean value) {
setUnsignedTypes(value);
return this;
}
/**
* Include display width in type declaration. In some RDBMS (e.g. MariaDB, MySQL), fixed width integer types are optionally accompanied by a display width. This is sometimes abused to model BOOLEAN types via TINYINT(1). This flag allows for including that display width in the type declaration exposed by jOOQ-meta code, as if it were a numeric precision.
*
*/
public Database withIntegerDisplayWidths(Boolean value) {
setIntegerDisplayWidths(value);
return this;
@ -2535,6 +2701,11 @@ public class Database implements Serializable, XMLAppendable
return this;
}
/**
* A flag to indicate that the outputCatalog should be the "default" catalog,
* which generates catalog-less, unqualified tables, procedures, etc.
*
*/
public Database withOutputCatalogToDefault(Boolean value) {
setOutputCatalogToDefault(value);
return this;
@ -2567,6 +2738,11 @@ public class Database implements Serializable, XMLAppendable
return this;
}
/**
* A flag to indicate that the outputSchema should be the "default" schema,
* which generates schema-less, unqualified tables, procedures, etc.
*
*/
public Database withOutputSchemaToDefault(Boolean value) {
setOutputSchemaToDefault(value);
return this;
@ -2659,41 +2835,89 @@ public class Database implements Serializable, XMLAppendable
return this;
}
/**
* Whether identity columns should expose {@link org.jooq.DataType#readonly()} behaviour.
* <p>
* This feature is available in the commercial distribution only.
*
*/
public Database withReadonlyIdentities(Boolean value) {
setReadonlyIdentities(value);
return this;
}
/**
* Whether computed columns should expose {@link org.jooq.DataType#readonly()} behaviour.
* <p>
* This feature is available in the commercial distribution only.
*
*/
public Database withReadonlyComputedColumns(Boolean value) {
setReadonlyComputedColumns(value);
return this;
}
/**
* Whether columns that are known not to be updatable (e.g. in views) should expose {@link org.jooq.DataType#readonly()} behaviour.
* <p>
* This feature is available in the commercial distribution only.
*
*/
public Database withReadonlyNonUpdatableColumns(Boolean value) {
setReadonlyNonUpdatableColumns(value);
return this;
}
/**
* Enable some default forced type configurations for built in data type extensions, such as the ones from the jooq-postgres-extensions module.
*
*/
public Database withForcedTypesForBuiltinDataTypeExtensions(Boolean value) {
setForcedTypesForBuiltinDataTypeExtensions(value);
return this;
}
/**
* Enable some default forced type configurations for XML schema collections, mapping them to JAXB annotated types using the {@link org.jooq.impl.XMLtoJAXBConverter}
* <p>
* This feature is available in the commercial distribution only.
*
*/
public Database withForcedTypesForXMLSchemaCollections(Boolean value) {
setForcedTypesForXMLSchemaCollections(value);
return this;
}
/**
* Historically, zero-scale decimal types are generated as their most appropriate, corresponding integer type (e.g. NUMBER(2, 0) and less: Byte). This allows for turning off this feature. In case of conflict between this rule and actual {@link #getForcedTypes()}, the latter will win.
*
*/
public Database withForceIntegerTypesOnZeroScaleDecimals(Boolean value) {
setForceIntegerTypesOnZeroScaleDecimals(value);
return this;
}
/**
* Whether table valued functions should be reported as tables.
* <p>
* If this is deactivated, such functions are not generated as tables, but
* as ordinary routines. This is particularly useful for backwards-
* compatibility between jOOQ 3.8 and previous versions, when using TABLE
* and VARRAY types in Oracle.
* <p>
* While this flag defaults to true for most databases, it defaults to false
* for Oracle.
*
*/
public Database withTableValuedFunctions(Boolean value) {
setTableValuedFunctions(value);
return this;
}
/**
* Specify whether to use the Oracle DBA_XYZ views instead of the ALL_XYZ views.
*
*/
public Database withOracleUseDBAViews(Boolean value) {
setOracleUseDBAViews(value);
return this;

6
jOOQ-meta/src/main/java/org/jooq/meta/jaxb/EmbeddableDefinitionType.java
View File

@ -178,7 +178,7 @@ public class EmbeddableDefinitionType implements Serializable, XMLAppendable
}
/**
* Sets the value of the replacesFields property.
* Specify that the embeddable field replaces its underlying fields in code generation output, and when working with asterisks.
*
* @param value
* allowed object is
@ -263,6 +263,10 @@ public class EmbeddableDefinitionType implements Serializable, XMLAppendable
return this;
}
/**
* Specify that the embeddable field replaces its underlying fields in code generation output, and when working with asterisks.
*
*/
public EmbeddableDefinitionType withReplacesFields(Boolean value) {
setReplacesFields(value);
return this;

92
jOOQ-meta/src/main/java/org/jooq/meta/jaxb/ForcedType.java
View File

@ -197,7 +197,11 @@ public class ForcedType implements Serializable, XMLAppendable
}
/**
* Sets the value of the auditInsertTimestamp property.
* Whether this column acts as an audit {@link org.jooq.GeneratorStatementType#INSERT} timestamp.
* <p>
* This flag produces a {@link #generator} configuration, so it cannot be combined with a custom generator. The different audit flags are mutually exclusive.
* <p>
* This feature is available in the commercial distribution only.
*
* @param value
* allowed object is
@ -225,7 +229,11 @@ public class ForcedType implements Serializable, XMLAppendable
}
/**
* Sets the value of the auditInsertUser property.
* Whether this column acts as an audit {@link org.jooq.GeneratorStatementType#INSERT} timestamp.
* <p>
* This flag produces a {@link #generator} configuration, so it cannot be combined with a custom generator. The different audit flags are mutually exclusive.
* <p>
* This feature is available in the commercial distribution only.
*
* @param value
* allowed object is
@ -253,7 +261,11 @@ public class ForcedType implements Serializable, XMLAppendable
}
/**
* Sets the value of the auditUpdateTimestamp property.
* Whether this column acts as an audit {@link org.jooq.GeneratorStatementType#UPDATE} timestamp.
* <p>
* This flag produces a {@link #generator} configuration, so it cannot be combined with a custom generator. The different audit flags are mutually exclusive.
* <p>
* This feature is available in the commercial distribution only.
*
* @param value
* allowed object is
@ -281,7 +293,11 @@ public class ForcedType implements Serializable, XMLAppendable
}
/**
* Sets the value of the auditUpdateUser property.
* Whether this column acts as an audit {@link org.jooq.GeneratorStatementType#UPDATE} timestamp.
* <p>
* This flag produces a {@link #generator} configuration, so it cannot be combined with a custom generator. The different audit flags are mutually exclusive.
* <p>
* This feature is available in the commercial distribution only.
*
* @param value
* allowed object is
@ -321,7 +337,7 @@ public class ForcedType implements Serializable, XMLAppendable
}
/**
* Sets the value of the genericConverter property.
* Whether the converter is generic, receiving <code>&lt;T, U&gt;</code> type variables as well as <code>Class&lt;T&gt;</class> and <code>Class&lt;U&gt;</class> constructor arguments.
*
* @param value
* allowed object is
@ -345,7 +361,7 @@ public class ForcedType implements Serializable, XMLAppendable
}
/**
* Sets the value of the autoConverter property.
* Whether the converter is an {@link org.jooq.impl.AutoConverter}.
*
* @param value
* allowed object is
@ -369,7 +385,7 @@ public class ForcedType implements Serializable, XMLAppendable
}
/**
* Sets the value of the enumConverter property.
* Whether the converter is an {@link org.jooq.impl.EnumConverter}.
*
* @param value
* allowed object is
@ -393,7 +409,7 @@ public class ForcedType implements Serializable, XMLAppendable
}
/**
* Sets the value of the xmlConverter property.
* Whether the converter is an {@link org.jooq.impl.XMLtoJAXBConverter}.
*
* @param value
* allowed object is
@ -417,7 +433,7 @@ public class ForcedType implements Serializable, XMLAppendable
}
/**
* Sets the value of the jsonConverter property.
* Whether the converter is an {@link org.jooq.jackson.extensions.converters.JSONtoJacksonConverter} or a {@link org.jooq.jackson.extensions.converters.JSONtoJacksonConverter}.
*
* @param value
* allowed object is
@ -473,7 +489,7 @@ public class ForcedType implements Serializable, XMLAppendable
}
/**
* Sets the value of the genericBinding property.
* Whether the binding is generic, receiving <code>&lt;T, U&gt;</code> type variables as well as <code>Class&lt;T&gt;</class> and <code>Class&lt;U&gt;</class> constructor arguments.
*
* @param value
* allowed object is
@ -714,21 +730,53 @@ public class ForcedType implements Serializable, XMLAppendable
return this;
}
/**
* Whether this column acts as an audit {@link org.jooq.GeneratorStatementType#INSERT} timestamp.
* <p>
* This flag produces a {@link #generator} configuration, so it cannot be combined with a custom generator. The different audit flags are mutually exclusive.
* <p>
* This feature is available in the commercial distribution only.
*
*/
public ForcedType withAuditInsertTimestamp(Boolean value) {
setAuditInsertTimestamp(value);
return this;
}
/**
* Whether this column acts as an audit {@link org.jooq.GeneratorStatementType#INSERT} timestamp.
* <p>
* This flag produces a {@link #generator} configuration, so it cannot be combined with a custom generator. The different audit flags are mutually exclusive.
* <p>
* This feature is available in the commercial distribution only.
*
*/
public ForcedType withAuditInsertUser(Boolean value) {
setAuditInsertUser(value);
return this;
}
/**
* Whether this column acts as an audit {@link org.jooq.GeneratorStatementType#UPDATE} timestamp.
* <p>
* This flag produces a {@link #generator} configuration, so it cannot be combined with a custom generator. The different audit flags are mutually exclusive.
* <p>
* This feature is available in the commercial distribution only.
*
*/
public ForcedType withAuditUpdateTimestamp(Boolean value) {
setAuditUpdateTimestamp(value);
return this;
}
/**
* Whether this column acts as an audit {@link org.jooq.GeneratorStatementType#UPDATE} timestamp.
* <p>
* This flag produces a {@link #generator} configuration, so it cannot be combined with a custom generator. The different audit flags are mutually exclusive.
* <p>
* This feature is available in the commercial distribution only.
*
*/
public ForcedType withAuditUpdateUser(Boolean value) {
setAuditUpdateUser(value);
return this;
@ -743,26 +791,46 @@ public class ForcedType implements Serializable, XMLAppendable
return this;
}
/**
* Whether the converter is generic, receiving <code>&lt;T, U&gt;</code> type variables as well as <code>Class&lt;T&gt;</class> and <code>Class&lt;U&gt;</class> constructor arguments.
*
*/
public ForcedType withGenericConverter(Boolean value) {
setGenericConverter(value);
return this;
}
/**
* Whether the converter is an {@link org.jooq.impl.AutoConverter}.
*
*/
public ForcedType withAutoConverter(Boolean value) {
setAutoConverter(value);
return this;
}
/**
* Whether the converter is an {@link org.jooq.impl.EnumConverter}.
*
*/
public ForcedType withEnumConverter(Boolean value) {
setEnumConverter(value);
return this;
}
/**
* Whether the converter is an {@link org.jooq.impl.XMLtoJAXBConverter}.
*
*/
public ForcedType withXmlConverter(Boolean value) {
setXmlConverter(value);
return this;
}
/**
* Whether the converter is an {@link org.jooq.jackson.extensions.converters.JSONtoJacksonConverter} or a {@link org.jooq.jackson.extensions.converters.JSONtoJacksonConverter}.
*
*/
public ForcedType withJsonConverter(Boolean value) {
setJsonConverter(value);
return this;
@ -786,6 +854,10 @@ public class ForcedType implements Serializable, XMLAppendable
return this;
}
/**
* Whether the binding is generic, receiving <code>&lt;T, U&gt;</code> type variables as well as <code>Class&lt;T&gt;</class> and <code>Class&lt;U&gt;</class> constructor arguments.
*
*/
public ForcedType withGenericBinding(Boolean value) {
setGenericBinding(value);
return this;

690
jOOQ-meta/src/main/java/org/jooq/meta/jaxb/Generate.java
View File

File diff suppressed because it is too large Load Diff

6
jOOQ-meta/src/main/java/org/jooq/meta/jaxb/Jdbc.java
View File

@ -166,7 +166,7 @@ public class Jdbc implements Serializable, XMLAppendable
}
/**
* Sets the value of the autoCommit property.
* The value of the JDBC autocommit flag. The flag is not set by default, i.e. it keeps the default provided to jOOQ.
*
* @param value
* allowed object is
@ -275,6 +275,10 @@ public class Jdbc implements Serializable, XMLAppendable
return this;
}
/**
* The value of the JDBC autocommit flag. The flag is not set by default, i.e. it keeps the default provided to jOOQ.
*
*/
public Jdbc withAutoCommit(Boolean value) {
setAutoCommit(value);
return this;

6
jOOQ-meta/src/main/java/org/jooq/meta/jaxb/LambdaConverter.java
View File

@ -83,7 +83,7 @@ public class LambdaConverter implements Serializable, XMLAppendable
}
/**
* Sets the value of the nullable property.
* Whether to use {@link org.jooq.Converter#ofNullable(Class, Class, java.util.function.Function, java.util.function.Function)} or {@link org.jooq.Converter#of(Class, Class, java.util.function.Function, java.util.function.Function)}.
*
* @param value
* allowed object is
@ -112,6 +112,10 @@ public class LambdaConverter implements Serializable, XMLAppendable
return this;
}
/**
* Whether to use {@link org.jooq.Converter#ofNullable(Class, Class, java.util.function.Function, java.util.function.Function)} or {@link org.jooq.Converter#of(Class, Class, java.util.function.Function, java.util.function.Function)}.
*
*/
public LambdaConverter withNullable(Boolean value) {
setNullable(value);
return this;

6
jOOQ-meta/src/main/java/org/jooq/meta/jaxb/SchemaMappingType.java
View File

@ -82,7 +82,7 @@ public class SchemaMappingType implements Serializable, XMLAppendable
}
/**
* Sets the value of the outputSchemaToDefault property.
* See also {@link Database#isOutputSchemaToDefault()}
*
* @param value
* allowed object is
@ -111,6 +111,10 @@ public class SchemaMappingType implements Serializable, XMLAppendable
return this;
}
/**
* See also {@link Database#isOutputSchemaToDefault()}
*
*/
public SchemaMappingType withOutputSchemaToDefault(Boolean value) {
setOutputSchemaToDefault(value);
return this;

12
jOOQ-meta/src/main/java/org/jooq/meta/jaxb/SyntheticEnumType.java
View File

@ -146,7 +146,7 @@ public class SyntheticEnumType implements Serializable, XMLAppendable
}
/**
* Sets the value of the literalsFromColumnContent property.
* The matched column's content defines the literals (this is convenience for {@link #literalSql} being <code>SELECT DISTINCT matched_column FROM matched_table</code>).
*
* @param value
* allowed object is
@ -170,7 +170,7 @@ public class SyntheticEnumType implements Serializable, XMLAppendable
}
/**
* Sets the value of the literalsFromCheckConstraints property.
* The list of literals is parsed from the applicable <code>CHECK</code> constraints for the matched column, if possible.
*
* @param value
* allowed object is
@ -244,11 +244,19 @@ public class SyntheticEnumType implements Serializable, XMLAppendable
return this;
}
/**
* The matched column's content defines the literals (this is convenience for {@link #literalSql} being <code>SELECT DISTINCT matched_column FROM matched_table</code>).
*
*/
public SyntheticEnumType withLiteralsFromColumnContent(Boolean value) {
setLiteralsFromColumnContent(value);
return this;
}
/**
* The list of literals is parsed from the applicable <code>CHECK</code> constraints for the matched column, if possible.
*
*/
public SyntheticEnumType withLiteralsFromCheckConstraints(Boolean value) {
setLiteralsFromCheckConstraints(value);
return this;

6
jOOQ-meta/src/main/java/org/jooq/meta/jaxb/Target.java
View File

@ -126,7 +126,7 @@ public class Target implements Serializable, XMLAppendable
}
/**
* Sets the value of the clean property.
* Whether the target package should be cleaned to contain only generated code after a generation run.
*
* @param value
* allowed object is
@ -176,6 +176,10 @@ public class Target implements Serializable, XMLAppendable
return this;
}
/**
* Whether the target package should be cleaned to contain only generated code after a generation run.
*
*/
public Target withClean(Boolean value) {
setClean(value);
return this;

1956
jOOQ/src/main/java/org/jooq/conf/Settings.java
View File

File diff suppressed because it is too large Load Diff