- All Implemented Interfaces:
Serializable,XMLAppendable
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Stringprotected Stringprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Stringprotected Booleanprotected Booleanprotected Booleanprotected GeneratedAnnotationTypeprotected GeneratedSerialVersionUIDprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Stringprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Stringprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Integerprotected Stringprotected Booleanprotected Stringprotected Booleanprotected Booleanprotected Stringprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Stringprotected Stringprotected Booleanprotected Stringprotected Stringprotected Booleanprotected Integerprotected Booleanprotected Booleanprotected Stringprotected Booleanprotected Stringprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected GeneratedTextBlocksprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected Booleanprotected VisibilityModifierprotected Booleanprotected Boolean -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal voidappendTo(XMLBuilder builder) booleanAll the object identifiers for which not to generate DAOs.All the object identifiers for which to generate DAOs, by default, all of them.A regular expression matching all the types in generated code that should be fully qualified.Specify the type ofGeneratedannotation to use in generated code.The serial version UID to be generated in all files.The indentation characters to be used in generated code.Version of JPA specification is to be used to generate version-specific annotations.The maximum number of members per initialiser, to prevent reaching the 64kb byte code per method limit in generated code.The newline characters to be used in generated code.Specify the qualified annotation name for all non-nullable items in generated code, defaulting to the JSR-305type.invalid reference
javax.annotation.NonnullSpecify the qualified annotation name for all nullable items in generated code, defaulting to the JSR-305type.invalid reference
javax.annotation.NullableA regular expression matching columns for exclusion in generated equals() and hashCode() methods in POJOs.A regular expression matching columns for inclusion in generated equals() and hashCode() methods in POJOs.All the object identifiers for which not to generate POJOs.All the object identifiers for which to generate POJOs, by default, all of them.The print margin to apply to generated Javadoc and other block comments, for automatic line wrapping.All the object identifiers for which not to generate records.All the object identifiers for which to generate records, by default, all of them.Whether to generate String in text block format.The visibility modifier to be used with generated code.inthashCode()Whether to generate overrides forTable.as(org.jooq.Name)and related overloads.Turn off generation of all SQL comments as Javadoc on all objects.Turn off generation of all SQL comments as Javadoc on all attributes.Turn off generation of all SQL comments as Javadoc on all catalogs.Turn off generation of all SQL comments as Javadoc on all columns.Turn off generation of all SQL comments as Javadoc on all domains.Turn off generation of all SQL comments as Javadoc on all embeddables.Turn off generation of all SQL comments as Javadoc on all keys.Turn off generation of all SQL comments as Javadoc on all links.Turn off generation of all SQL comments as Javadoc on all packages.Turn off generation of all SQL comments as Javadoc on all parameters.Turn off generation of all SQL comments as Javadoc on all queues.Turn off generation of all SQL comments as Javadoc on all routines.Turn off generation of all SQL comments as Javadoc on all schemas.Turn off generation of all SQL comments as Javadoc on all sequences.Turn off generation of all SQL comments as Javadoc on all tables.Turn off generation of all SQL comments as Javadoc on all UDTs.Generate theConstructorPropertiesannotation on generated POJOs and/or records.Generate theConstructorPropertiesannotation on generated POJOs (defaults totrueifconstructorPropertiesAnnotationis active).Generate theConstructorPropertiesannotation on generated records (defaults totrueifconstructorPropertiesAnnotationis active).isDaos()Generate DAOs.A flag indicating whether the DECFLOAT type support should be enabled.Turn off generation of aDefaultCatalogobject, which is generated by default in the absence of catalogs.Turn off generation of aDefaultSchemaobject, which is generated by default in the absence of schemas.Generate deprecated code for backwards compatibilityGenerate deprecation annotations on references to unknown data types.Generate embeddable classes.Whether empty catalogs (e.g.Whether empty schemas (e.g.Generate enums as Scala 3.0 enums (if Scala 3 is supported).Deprecated.Activate the legacy Scala sealed trait enum emulationGenerate fluent setters in records, POJOs, interfaces.Use theGeneratedannotation specified bygetGeneratedAnnotationType()in generated code.Whether theGeneratedannotation specified bygetGeneratedAnnotationType()should include thedateattribute.Whether theGeneratedannotation specified bygetGeneratedAnnotationType()should include the jOOQ version.Turn off generation of global catalog references.Turn off generation of global domain references.Turn off generation of global index references.Turn off generation of global key references.Turn off generation of global database link references.Turn on generation of all global object names.Turn off generation of all global object references.Turn off generation of global queue references.Turn off generation of global routine references.Turn off generation of global schema references.Turn off generation of global sequence references.Turn off generation of global synonym references.Turn off generation of global table references.Turn off generation of global trigger references.Turn off generation of global UDT references.Whether hidden columns should be generated in interfaces.Whether hidden columns should be generated in POJOs.Whether hidden columns should be generated in records.Generate immutable interfaces.Generate immutable POJOs.Whether implicit join path constructors should be offered as properties in Kotlin.Generate implicit join path constructors on generated tables for many-to-many relationships.Generate implicit join path constructors on generated tables for incoming foreign key relationships (to-many relationships)Generate implicit join path constructors on generated tables for outgoing foreign key relationships (to-one relationships)Whether names of unambiguousForeignKeyDefinitionshould be based on the referencedTableDefinition.Generate implicit join path table subtypes implementingPathfor increased JOIN convenience.Generate implicit join path constructors also if there isn't any outgoing or incoming foreign key relationship.Generate index information.Deprecated.Generated interfaces to be implemented by records and/or POJOs.A flag indicating whether the INTERVAL type support should be enabled.Modify DefaultGeneratorStrategy behaviour to generate getters and setters in JavaBeans style in records, POJOs, interfaces.Turn off generation of Javadoc on all objects.A flag indicating whether Java 8's java.time types should be used by the source code generator, rather than JDBC's java.sql types.Generate references to the most up to date minor release inConstantsto produce compilation errors if an outdated runtime library is being used.Annotate POJOs and Records with JPA annotations.A flag indicating whether the JSON type support should be enabled.isKeys()Generate Key classes.Generate defaulted nullable POJO attributes.Generate defaulted nullable Record attributes.Generate non-nullable types on interface attributes, where column is not null.Generate non-nullable types on POJO attributes, where column is not null.Generate non-nullable types on Record attributes, where column is not null.Workaround for Kotlin generatingsetX()setters instead ofsetIsX()in byte code for mutable properties calledisX.isLinks()Generate database Link classes.Whether non-nullable items should be annotated with the annotation type specified innonnullAnnotationType.Whether nullable items should be annotated with the annotation type specified innullableAnnotationType.Whether write-only (e.g.isPojos()Generate POJOs.Generate POJOs as records, when using the JavaGenerator.Generate POJOs as data classes, when using the KotlinGenerator.Generate POJOs as case classes, when using the ScalaGenerator or Scala3Generator.Generate basic equals() and hashCode() methods in POJOs.Include primary key columns only in generated equals() and hashCode() methods in POJOs.Generate basic toString() methods in POJOs.isQueues()Generate Queue classes.Generate TableRecord classes.Generate TableRecord classes that implement Record[N] super typesPrimary key / foreign key relations should be generated and used.Whether to generate overrides (see https://github.com/jOOQ/jOOQ/issues/13937) forand related overloads.invalid reference
org.jooq.Table#rename(org.jooq.Name)Generate Routine classes.Sequence flags should be generated and used.Generate Sequence classes.Generate serializable interfaces.Generate serializable POJOs.Turn off generation of all source code on all object types.Turn off generation of all source code on all views.A flag indicating whether the spatial type support should be enabled.Annotate DAOs with useful spring annotations such as @Repository or @Autowired.Generate an AbstractSpringDAOImpl as a base class for other DAO classes, containing @Transactional annotations, etc.Generate Synonym classes.isTables()Generate Table classes.Generate Trigger classes.Generate UDT path expressions on tables and on UDTs.isUdts()Generate UDT classes.Annotate POJOs and Records with JSR-303 validation annotationsGenerate varargs setters for array types for convenience.Whether to generate overrides forTable.where(org.jooq.Condition)and related overloads.A flag indicating whether the XML type support should be enabled.voidsetAsMethodOverrides(Boolean value) Whether to generate overrides forTable.as(org.jooq.Name)and related overloads.voidsetComments(Boolean value) Turn off generation of all SQL comments as Javadoc on all objects.voidsetCommentsOnAttributes(Boolean value) Turn off generation of all SQL comments as Javadoc on all attributes.voidsetCommentsOnCatalogs(Boolean value) Turn off generation of all SQL comments as Javadoc on all catalogs.voidsetCommentsOnColumns(Boolean value) Turn off generation of all SQL comments as Javadoc on all columns.voidsetCommentsOnDomains(Boolean value) Turn off generation of all SQL comments as Javadoc on all domains.voidsetCommentsOnEmbeddables(Boolean value) Turn off generation of all SQL comments as Javadoc on all embeddables.voidsetCommentsOnKeys(Boolean value) Turn off generation of all SQL comments as Javadoc on all keys.voidsetCommentsOnLinks(Boolean value) Turn off generation of all SQL comments as Javadoc on all links.voidsetCommentsOnPackages(Boolean value) Turn off generation of all SQL comments as Javadoc on all packages.voidsetCommentsOnParameters(Boolean value) Turn off generation of all SQL comments as Javadoc on all parameters.voidsetCommentsOnQueues(Boolean value) Turn off generation of all SQL comments as Javadoc on all queues.voidsetCommentsOnRoutines(Boolean value) Turn off generation of all SQL comments as Javadoc on all routines.voidsetCommentsOnSchemas(Boolean value) Turn off generation of all SQL comments as Javadoc on all schemas.voidsetCommentsOnSequences(Boolean value) Turn off generation of all SQL comments as Javadoc on all sequences.voidsetCommentsOnTables(Boolean value) Turn off generation of all SQL comments as Javadoc on all tables.voidsetCommentsOnUDTs(Boolean value) Turn off generation of all SQL comments as Javadoc on all UDTs.voidGenerate theConstructorPropertiesannotation on generated POJOs and/or records.voidGenerate theConstructorPropertiesannotation on generated POJOs (defaults totrueifconstructorPropertiesAnnotationis active).voidGenerate theConstructorPropertiesannotation on generated records (defaults totrueifconstructorPropertiesAnnotationis active).voidGenerate DAOs.voidsetDaosExcludes(String value) All the object identifiers for which not to generate DAOs.voidsetDaosIncludes(String value) All the object identifiers for which to generate DAOs, by default, all of them.voidsetDecfloatTypes(Boolean value) A flag indicating whether the DECFLOAT type support should be enabled.voidsetDefaultCatalog(Boolean value) Turn off generation of aDefaultCatalogobject, which is generated by default in the absence of catalogs.voidsetDefaultSchema(Boolean value) Turn off generation of aDefaultSchemaobject, which is generated by default in the absence of schemas.voidsetDeprecated(Boolean value) Generate deprecated code for backwards compatibilityvoidGenerate deprecation annotations on references to unknown data types.voidsetEmbeddables(Boolean value) Generate embeddable classes.voidsetEmptyCatalogs(Boolean value) Whether empty catalogs (e.g.voidsetEmptySchemas(Boolean value) Whether empty schemas (e.g.voidsetEnumsAsScalaEnums(Boolean value) Generate enums as Scala 3.0 enums (if Scala 3 is supported).voidDeprecated.Activate the legacy Scala sealed trait enum emulationvoidsetFluentSetters(Boolean value) Generate fluent setters in records, POJOs, interfaces.voidsetFullyQualifiedTypes(String value) A regular expression matching all the types in generated code that should be fully qualified.voidsetGeneratedAnnotation(Boolean value) Use theGeneratedannotation specified bygetGeneratedAnnotationType()in generated code.voidWhether theGeneratedannotation specified bygetGeneratedAnnotationType()should include thedateattribute.voidWhether theGeneratedannotation specified bygetGeneratedAnnotationType()should include the jOOQ version.voidSpecify the type ofGeneratedannotation to use in generated code.voidThe serial version UID to be generated in all files.voidTurn off generation of global catalog references.voidsetGlobalDomainReferences(Boolean value) Turn off generation of global domain references.voidsetGlobalIndexReferences(Boolean value) Turn off generation of global index references.voidsetGlobalKeyReferences(Boolean value) Turn off generation of global key references.voidsetGlobalLinkReferences(Boolean value) Turn off generation of global database link references.voidsetGlobalObjectNames(Boolean value) Turn on generation of all global object names.voidsetGlobalObjectReferences(Boolean value) Turn off generation of all global object references.voidsetGlobalQueueReferences(Boolean value) Turn off generation of global queue references.voidTurn off generation of global routine references.voidsetGlobalSchemaReferences(Boolean value) Turn off generation of global schema references.voidTurn off generation of global sequence references.voidTurn off generation of global synonym references.voidsetGlobalTableReferences(Boolean value) Turn off generation of global table references.voidTurn off generation of global trigger references.voidsetGlobalUDTReferences(Boolean value) Turn off generation of global UDT references.voidWhether hidden columns should be generated in interfaces.voidsetHiddenColumnsInPojos(Boolean value) Whether hidden columns should be generated in POJOs.voidsetHiddenColumnsInRecords(Boolean value) Whether hidden columns should be generated in records.voidsetImmutableInterfaces(Boolean value) Generate immutable interfaces.voidsetImmutablePojos(Boolean value) Generate immutable POJOs.voidWhether implicit join path constructors should be offered as properties in Kotlin.voidGenerate implicit join path constructors on generated tables for many-to-many relationships.voidGenerate implicit join path constructors on generated tables for incoming foreign key relationships (to-many relationships)voidsetImplicitJoinPathsToOne(Boolean value) Generate implicit join path constructors on generated tables for outgoing foreign key relationships (to-one relationships)voidWhether names of unambiguousForeignKeyDefinitionshould be based on the referencedTableDefinition.voidGenerate implicit join path table subtypes implementingPathfor increased JOIN convenience.voidGenerate implicit join path constructors also if there isn't any outgoing or incoming foreign key relationship.voidsetIndentation(String value) The indentation characters to be used in generated code.voidsetIndexes(Boolean value) Generate index information.voidsetInstanceFields(Boolean value) Deprecated.voidsetInterfaces(Boolean value) Generated interfaces to be implemented by records and/or POJOs.voidsetIntervalTypes(Boolean value) A flag indicating whether the INTERVAL type support should be enabled.voidModify DefaultGeneratorStrategy behaviour to generate getters and setters in JavaBeans style in records, POJOs, interfaces.voidsetJavadoc(Boolean value) Turn off generation of Javadoc on all objects.voidsetJavaTimeTypes(Boolean value) A flag indicating whether Java 8's java.time types should be used by the source code generator, rather than JDBC's java.sql types.voidsetJooqVersionReference(Boolean value) Generate references to the most up to date minor release inConstantsto produce compilation errors if an outdated runtime library is being used.voidsetJpaAnnotations(Boolean value) Annotate POJOs and Records with JPA annotations.voidsetJpaVersion(String value) Version of JPA specification is to be used to generate version-specific annotations.voidsetJsonTypes(Boolean value) A flag indicating whether the JSON type support should be enabled.voidGenerate Key classes.voidGenerate defaulted nullable POJO attributes.voidGenerate defaulted nullable Record attributes.voidGenerate non-nullable types on interface attributes, where column is not null.voidGenerate non-nullable types on POJO attributes, where column is not null.voidGenerate non-nullable types on Record attributes, where column is not null.voidWorkaround for Kotlin generatingsetX()setters instead ofsetIsX()in byte code for mutable properties calledisX.voidGenerate database Link classes.voidThe maximum number of members per initialiser, to prevent reaching the 64kb byte code per method limit in generated code.voidsetNewline(String value) The newline characters to be used in generated code.voidsetNonnullAnnotation(Boolean value) Whether non-nullable items should be annotated with the annotation type specified innonnullAnnotationType.voidsetNonnullAnnotationType(String value) Specify the qualified annotation name for all non-nullable items in generated code, defaulting to the JSR-305type.invalid reference
javax.annotation.NonnullvoidsetNullableAnnotation(Boolean value) Whether nullable items should be annotated with the annotation type specified innullableAnnotationType.voidWhether write-only (e.g.voidsetNullableAnnotationType(String value) Specify the qualified annotation name for all nullable items in generated code, defaulting to the JSR-305type.invalid reference
javax.annotation.NullablevoidGenerate POJOs.voidGenerate POJOs as records, when using the JavaGenerator.voidGenerate POJOs as data classes, when using the KotlinGenerator.voidGenerate POJOs as case classes, when using the ScalaGenerator or Scala3Generator.voidsetPojosEqualsAndHashCode(Boolean value) Generate basic equals() and hashCode() methods in POJOs.voidA regular expression matching columns for exclusion in generated equals() and hashCode() methods in POJOs.voidA regular expression matching columns for inclusion in generated equals() and hashCode() methods in POJOs.voidInclude primary key columns only in generated equals() and hashCode() methods in POJOs.voidsetPojosExcludes(String value) All the object identifiers for which not to generate POJOs.voidsetPojosIncludes(String value) All the object identifiers for which to generate POJOs, by default, all of them.voidsetPojosToString(Boolean value) Generate basic toString() methods in POJOs.voidThe print margin to apply to generated Javadoc and other block comments, for automatic line wrapping.voidGenerate Queue classes.voidsetRecords(Boolean value) Generate TableRecord classes.voidsetRecordsExcludes(String value) All the object identifiers for which not to generate records.voidGenerate TableRecord classes that implement Record[N] super typesvoidsetRecordsIncludes(String value) All the object identifiers for which to generate records, by default, all of them.voidsetRelations(Boolean value) Primary key / foreign key relations should be generated and used.voidsetRenameMethodOverrides(Boolean value) Whether to generate overrides (see https://github.com/jOOQ/jOOQ/issues/13937) forand related overloads.invalid reference
org.jooq.Table#rename(org.jooq.Name)voidsetRoutines(Boolean value) Generate Routine classes.voidsetSequenceFlags(Boolean value) Sequence flags should be generated and used.voidsetSequences(Boolean value) Generate Sequence classes.voidsetSerializableInterfaces(Boolean value) Generate serializable interfaces.voidsetSerializablePojos(Boolean value) Generate serializable POJOs.voidsetSources(Boolean value) Turn off generation of all source code on all object types.voidsetSourcesOnViews(Boolean value) Turn off generation of all source code on all views.voidsetSpatialTypes(Boolean value) A flag indicating whether the spatial type support should be enabled.voidsetSpringAnnotations(Boolean value) Annotate DAOs with useful spring annotations such as @Repository or @Autowired.voidsetSpringDao(Boolean value) Generate an AbstractSpringDAOImpl as a base class for other DAO classes, containing @Transactional annotations, etc.voidsetSynonyms(Boolean value) Generate Synonym classes.voidGenerate Table classes.voidsetTextBlocks(GeneratedTextBlocks value) Whether to generate String in text block format.voidsetTriggers(Boolean value) Generate Trigger classes.voidsetUdtPaths(Boolean value) Generate UDT path expressions on tables and on UDTs.voidGenerate UDT classes.voidsetValidationAnnotations(Boolean value) Annotate POJOs and Records with JSR-303 validation annotationsvoidsetVarargSetters(Boolean value) Generate varargs setters for array types for convenience.voidThe visibility modifier to be used with generated code.voidsetWhereMethodOverrides(Boolean value) Whether to generate overrides forTable.where(org.jooq.Condition)and related overloads.voidsetXmlTypes(Boolean value) A flag indicating whether the XML type support should be enabled.toString()withAsMethodOverrides(Boolean value) Whether to generate overrides forTable.as(org.jooq.Name)and related overloads.withComments(Boolean value) Turn off generation of all SQL comments as Javadoc on all objects.withCommentsOnAttributes(Boolean value) Turn off generation of all SQL comments as Javadoc on all attributes.withCommentsOnCatalogs(Boolean value) Turn off generation of all SQL comments as Javadoc on all catalogs.withCommentsOnColumns(Boolean value) Turn off generation of all SQL comments as Javadoc on all columns.withCommentsOnDomains(Boolean value) Turn off generation of all SQL comments as Javadoc on all domains.withCommentsOnEmbeddables(Boolean value) Turn off generation of all SQL comments as Javadoc on all embeddables.withCommentsOnKeys(Boolean value) Turn off generation of all SQL comments as Javadoc on all keys.withCommentsOnLinks(Boolean value) Turn off generation of all SQL comments as Javadoc on all links.withCommentsOnPackages(Boolean value) Turn off generation of all SQL comments as Javadoc on all packages.withCommentsOnParameters(Boolean value) Turn off generation of all SQL comments as Javadoc on all parameters.withCommentsOnQueues(Boolean value) Turn off generation of all SQL comments as Javadoc on all queues.withCommentsOnRoutines(Boolean value) Turn off generation of all SQL comments as Javadoc on all routines.withCommentsOnSchemas(Boolean value) Turn off generation of all SQL comments as Javadoc on all schemas.withCommentsOnSequences(Boolean value) Turn off generation of all SQL comments as Javadoc on all sequences.withCommentsOnTables(Boolean value) Turn off generation of all SQL comments as Javadoc on all tables.withCommentsOnUDTs(Boolean value) Turn off generation of all SQL comments as Javadoc on all UDTs.Generate theConstructorPropertiesannotation on generated POJOs and/or records.Generate theConstructorPropertiesannotation on generated POJOs (defaults totrueifconstructorPropertiesAnnotationis active).Generate theConstructorPropertiesannotation on generated records (defaults totrueifconstructorPropertiesAnnotationis active).Generate DAOs.withDaosExcludes(String value) All the object identifiers for which not to generate DAOs.withDaosIncludes(String value) All the object identifiers for which to generate DAOs, by default, all of them.withDecfloatTypes(Boolean value) A flag indicating whether the DECFLOAT type support should be enabled.withDefaultCatalog(Boolean value) Turn off generation of aDefaultCatalogobject, which is generated by default in the absence of catalogs.withDefaultSchema(Boolean value) Turn off generation of aDefaultSchemaobject, which is generated by default in the absence of schemas.withDeprecated(Boolean value) Generate deprecated code for backwards compatibilityGenerate deprecation annotations on references to unknown data types.withEmbeddables(Boolean value) Generate embeddable classes.withEmptyCatalogs(Boolean value) Whether empty catalogs (e.g.withEmptySchemas(Boolean value) Whether empty schemas (e.g.withEnumsAsScalaEnums(Boolean value) Generate enums as Scala 3.0 enums (if Scala 3 is supported).Deprecated.Activate the legacy Scala sealed trait enum emulationwithFluentSetters(Boolean value) Generate fluent setters in records, POJOs, interfaces.withFullyQualifiedTypes(String value) A regular expression matching all the types in generated code that should be fully qualified.withGeneratedAnnotation(Boolean value) Use theGeneratedannotation specified bygetGeneratedAnnotationType()in generated code.Whether theGeneratedannotation specified bygetGeneratedAnnotationType()should include thedateattribute.Whether theGeneratedannotation specified bygetGeneratedAnnotationType()should include the jOOQ version.Specify the type ofGeneratedannotation to use in generated code.The serial version UID to be generated in all files.Turn off generation of global catalog references.Turn off generation of global domain references.withGlobalIndexReferences(Boolean value) Turn off generation of global index references.withGlobalKeyReferences(Boolean value) Turn off generation of global key references.withGlobalLinkReferences(Boolean value) Turn off generation of global database link references.withGlobalObjectNames(Boolean value) Turn on generation of all global object names.Turn off generation of all global object references.withGlobalQueueReferences(Boolean value) Turn off generation of global queue references.Turn off generation of global routine references.Turn off generation of global schema references.Turn off generation of global sequence references.Turn off generation of global synonym references.withGlobalTableReferences(Boolean value) Turn off generation of global table references.Turn off generation of global trigger references.withGlobalUDTReferences(Boolean value) Turn off generation of global UDT references.Whether hidden columns should be generated in interfaces.withHiddenColumnsInPojos(Boolean value) Whether hidden columns should be generated in POJOs.Whether hidden columns should be generated in records.withImmutableInterfaces(Boolean value) Generate immutable interfaces.withImmutablePojos(Boolean value) Generate immutable POJOs.Whether implicit join path constructors should be offered as properties in Kotlin.Generate implicit join path constructors on generated tables for many-to-many relationships.Generate implicit join path constructors on generated tables for incoming foreign key relationships (to-many relationships)Generate implicit join path constructors on generated tables for outgoing foreign key relationships (to-one relationships)Whether names of unambiguousForeignKeyDefinitionshould be based on the referencedTableDefinition.Generate implicit join path table subtypes implementingPathfor increased JOIN convenience.Generate implicit join path constructors also if there isn't any outgoing or incoming foreign key relationship.withIndentation(String value) The indentation characters to be used in generated code.withIndexes(Boolean value) Generate index information.withInstanceFields(Boolean value) Deprecated.withInterfaces(Boolean value) Generated interfaces to be implemented by records and/or POJOs.withIntervalTypes(Boolean value) A flag indicating whether the INTERVAL type support should be enabled.Modify DefaultGeneratorStrategy behaviour to generate getters and setters in JavaBeans style in records, POJOs, interfaces.withJavadoc(Boolean value) Turn off generation of Javadoc on all objects.withJavaTimeTypes(Boolean value) A flag indicating whether Java 8's java.time types should be used by the source code generator, rather than JDBC's java.sql types.withJooqVersionReference(Boolean value) Generate references to the most up to date minor release inConstantsto produce compilation errors if an outdated runtime library is being used.withJpaAnnotations(Boolean value) Annotate POJOs and Records with JPA annotations.withJpaVersion(String value) Version of JPA specification is to be used to generate version-specific annotations.withJsonTypes(Boolean value) A flag indicating whether the JSON type support should be enabled.Generate Key classes.Generate defaulted nullable POJO attributes.Generate defaulted nullable Record attributes.Generate non-nullable types on interface attributes, where column is not null.Generate non-nullable types on POJO attributes, where column is not null.Generate non-nullable types on Record attributes, where column is not null.Workaround for Kotlin generatingsetX()setters instead ofsetIsX()in byte code for mutable properties calledisX.Generate database Link classes.The maximum number of members per initialiser, to prevent reaching the 64kb byte code per method limit in generated code.withNewline(String value) The newline characters to be used in generated code.withNonnullAnnotation(Boolean value) Whether non-nullable items should be annotated with the annotation type specified innonnullAnnotationType.withNonnullAnnotationType(String value) Specify the qualified annotation name for all non-nullable items in generated code, defaulting to the JSR-305type.invalid reference
javax.annotation.NonnullwithNullableAnnotation(Boolean value) Whether nullable items should be annotated with the annotation type specified innullableAnnotationType.Whether write-only (e.g.withNullableAnnotationType(String value) Specify the qualified annotation name for all nullable items in generated code, defaulting to the JSR-305type.invalid reference
javax.annotation.NullableGenerate POJOs.Generate POJOs as records, when using the JavaGenerator.Generate POJOs as data classes, when using the KotlinGenerator.Generate POJOs as case classes, when using the ScalaGenerator or Scala3Generator.Generate basic equals() and hashCode() methods in POJOs.A regular expression matching columns for exclusion in generated equals() and hashCode() methods in POJOs.A regular expression matching columns for inclusion in generated equals() and hashCode() methods in POJOs.Include primary key columns only in generated equals() and hashCode() methods in POJOs.withPojosExcludes(String value) All the object identifiers for which not to generate POJOs.withPojosIncludes(String value) All the object identifiers for which to generate POJOs, by default, all of them.withPojosToString(Boolean value) Generate basic toString() methods in POJOs.The print margin to apply to generated Javadoc and other block comments, for automatic line wrapping.withQueues(Boolean value) Generate Queue classes.withRecords(Boolean value) Generate TableRecord classes.withRecordsExcludes(String value) All the object identifiers for which not to generate records.Generate TableRecord classes that implement Record[N] super typeswithRecordsIncludes(String value) All the object identifiers for which to generate records, by default, all of them.withRelations(Boolean value) Primary key / foreign key relations should be generated and used.withRenameMethodOverrides(Boolean value) Whether to generate overrides (see https://github.com/jOOQ/jOOQ/issues/13937) forand related overloads.invalid reference
org.jooq.Table#rename(org.jooq.Name)withRoutines(Boolean value) Generate Routine classes.withSequenceFlags(Boolean value) Sequence flags should be generated and used.withSequences(Boolean value) Generate Sequence classes.Generate serializable interfaces.withSerializablePojos(Boolean value) Generate serializable POJOs.withSources(Boolean value) Turn off generation of all source code on all object types.withSourcesOnViews(Boolean value) Turn off generation of all source code on all views.withSpatialTypes(Boolean value) A flag indicating whether the spatial type support should be enabled.withSpringAnnotations(Boolean value) Annotate DAOs with useful spring annotations such as @Repository or @Autowired.withSpringDao(Boolean value) Generate an AbstractSpringDAOImpl as a base class for other DAO classes, containing @Transactional annotations, etc.withSynonyms(Boolean value) Generate Synonym classes.withTables(Boolean value) Generate Table classes.Whether to generate String in text block format.withTriggers(Boolean value) Generate Trigger classes.withUdtPaths(Boolean value) Generate UDT path expressions on tables and on UDTs.Generate UDT classes.withValidationAnnotations(Boolean value) Annotate POJOs and Records with JSR-303 validation annotationswithVarargSetters(Boolean value) Generate varargs setters for array types for convenience.The visibility modifier to be used with generated code.withWhereMethodOverrides(Boolean value) Whether to generate overrides forTable.where(org.jooq.Condition)and related overloads.withXmlTypes(Boolean value) A flag indicating whether the XML type support should be enabled.
-
Field Details
-
indexes
-
relations
-
sequenceFlags
-
udtPaths
-
implicitJoinPathsToOne
-
implicitJoinPathsToMany
-
implicitJoinPathsManyToMany
-
implicitJoinPathTableSubtypes
-
implicitJoinPathUnusedConstructors
-
implicitJoinPathsUseTableNameForUnambiguousFKs
-
implicitJoinPathsAsKotlinProperties
-
deprecated
-
deprecationOnUnknownTypes
-
instanceFields
-
visibilityModifier
-
generatedAnnotation
-
generatedAnnotationType
-
generatedAnnotationDate
-
generatedAnnotationJooqVersion
-
nonnullAnnotation
-
nonnullAnnotationType
-
nullableAnnotation
-
nullableAnnotationOnWriteOnlyNullableTypes
-
nullableAnnotationType
-
constructorPropertiesAnnotation
-
constructorPropertiesAnnotationOnPojos
-
constructorPropertiesAnnotationOnRecords
-
routines
-
sequences
-
triggers
-
synonyms
-
udts
-
queues
-
links
-
keys
-
tables
-
embeddables
-
records
-
recordsIncludes
-
recordsExcludes
-
recordsImplementingRecordN
-
enumsAsScalaSealedTraits
-
enumsAsScalaEnums
-
pojos
-
pojosIncludes
-
pojosExcludes
-
pojosEqualsAndHashCode
-
pojosEqualsAndHashCodeIncludePrimaryKeyOnly
-
pojosEqualsAndHashCodeColumnIncludeExpression
-
pojosEqualsAndHashCodeColumnExcludeExpression
-
pojosToString
-
pojosAsJavaRecordClasses
-
pojosAsScalaCaseClasses
-
pojosAsKotlinDataClasses
-
immutablePojos
-
serializablePojos
-
interfaces
-
immutableInterfaces
-
serializableInterfaces
-
daos
-
daosIncludes
-
daosExcludes
-
jooqVersionReference
-
jpaAnnotations
-
jpaVersion
-
validationAnnotations
-
springAnnotations
-
springDao
-
kotlinSetterJvmNameAnnotationsOnIsPrefix
-
kotlinNotNullPojoAttributes
-
kotlinNotNullRecordAttributes
-
kotlinNotNullInterfaceAttributes
-
kotlinDefaultedNullablePojoAttributes
-
kotlinDefaultedNullableRecordAttributes
-
globalObjectNames
-
globalObjectReferences
-
globalCatalogReferences
-
globalSchemaReferences
-
globalDomainReferences
-
globalTriggerReferences
-
globalSynonymReferences
-
globalTableReferences
-
globalSequenceReferences
-
globalUDTReferences
-
globalRoutineReferences
-
globalQueueReferences
-
globalLinkReferences
-
globalKeyReferences
-
globalIndexReferences
-
defaultCatalog
-
defaultSchema
-
javadoc
-
comments
-
commentsOnCatalogs
-
commentsOnSchemas
-
commentsOnTables
-
commentsOnColumns
-
commentsOnEmbeddables
-
commentsOnUDTs
-
commentsOnAttributes
-
commentsOnPackages
-
commentsOnRoutines
-
commentsOnParameters
-
commentsOnSequences
-
commentsOnDomains
-
commentsOnLinks
-
commentsOnQueues
-
commentsOnKeys
-
sources
-
sourcesOnViews
-
fluentSetters
-
javaBeansGettersAndSetters
-
varargSetters
-
generatedSerialVersionUID
-
maxMembersPerInitialiser
-
fullyQualifiedTypes
-
emptyCatalogs
-
emptySchemas
-
javaTimeTypes
-
spatialTypes
-
xmlTypes
-
jsonTypes
-
intervalTypes
-
decfloatTypes
-
newline
-
indentation
-
printMarginForBlockComment
-
textBlocks
-
whereMethodOverrides
-
renameMethodOverrides
-
asMethodOverrides
-
-
Constructor Details
-
Generate
public Generate()
-
-
Method Details
-
isIndexes
Generate index information.- Returns:
- possible object is
Boolean
-
setIndexes
Generate index information.- Parameters:
value- allowed object isBoolean
-
isRelations
Primary key / foreign key relations should be generated and used. This is a prerequisite for various advanced features- Returns:
- possible object is
Boolean
-
setRelations
Primary key / foreign key relations should be generated and used. This is a prerequisite for various advanced features- Parameters:
value- allowed object isBoolean
-
isSequenceFlags
Sequence flags should be generated and used.- Returns:
- possible object is
Boolean
-
setSequenceFlags
Sequence flags should be generated and used.- Parameters:
value- allowed object isBoolean
-
isUdtPaths
Generate UDT path expressions on tables and on UDTs.- Returns:
- possible object is
Boolean
-
setUdtPaths
Generate UDT path expressions on tables and on UDTs.- Parameters:
value- allowed object isBoolean
-
isImplicitJoinPathsToOne
Generate implicit join path constructors on generated tables for outgoing foreign key relationships (to-one relationships)- Returns:
- possible object is
Boolean
-
setImplicitJoinPathsToOne
Generate implicit join path constructors on generated tables for outgoing foreign key relationships (to-one relationships)- Parameters:
value- allowed object isBoolean
-
isImplicitJoinPathsToMany
Generate implicit join path constructors on generated tables for incoming foreign key relationships (to-many relationships)- Returns:
- possible object is
Boolean
-
setImplicitJoinPathsToMany
Generate implicit join path constructors on generated tables for incoming foreign key relationships (to-many relationships)- Parameters:
value- allowed object isBoolean
-
isImplicitJoinPathsManyToMany
Generate implicit join path constructors on generated tables for many-to-many relationships. This turns off implicitly, if either of the other path generations are turned off.- Returns:
- possible object is
Boolean
-
setImplicitJoinPathsManyToMany
Generate implicit join path constructors on generated tables for many-to-many relationships. This turns off implicitly, if either of the other path generations are turned off.- Parameters:
value- allowed object isBoolean
-
isImplicitJoinPathTableSubtypes
Generate implicit join path table subtypes implementingPathfor increased JOIN convenience.- Returns:
- possible object is
Boolean
-
setImplicitJoinPathTableSubtypes
Generate implicit join path table subtypes implementingPathfor increased JOIN convenience.- Parameters:
value- allowed object isBoolean
-
isImplicitJoinPathUnusedConstructors
Generate implicit join path constructors also if there isn't any outgoing or incoming foreign key relationship.- Returns:
- possible object is
Boolean
-
setImplicitJoinPathUnusedConstructors
Generate implicit join path constructors also if there isn't any outgoing or incoming foreign key relationship.- Parameters:
value- allowed object isBoolean
-
isImplicitJoinPathsUseTableNameForUnambiguousFKs
Whether names of unambiguousForeignKeyDefinitionshould be based on the referencedTableDefinition.When a child table has only one
ForeignKeyDefinitiontowards a parent table, then that path is "unambiguous." In that case, someimplementations may choose to use the parent table'sinvalid reference
GeneratorStrategyTableDefinitionfor implementations of, instead of theinvalid reference
org.jooq.codegen.GeneratorStrategy#getJavaMethodName(Definition)ForeignKeyDefinition, e.g. for implicit join paths.This flag allows for turning off this default behaviour.
- Returns:
- possible object is
Boolean
-
setImplicitJoinPathsUseTableNameForUnambiguousFKs
Whether names of unambiguousForeignKeyDefinitionshould be based on the referencedTableDefinition.When a child table has only one
ForeignKeyDefinitiontowards a parent table, then that path is "unambiguous." In that case, someimplementations may choose to use the parent table'sinvalid reference
GeneratorStrategyTableDefinitionfor implementations of, instead of theinvalid reference
org.jooq.codegen.GeneratorStrategy#getJavaMethodName(Definition)ForeignKeyDefinition, e.g. for implicit join paths.This flag allows for turning off this default behaviour.
- Parameters:
value- allowed object isBoolean
-
isImplicitJoinPathsAsKotlinProperties
Whether implicit join path constructors should be offered as properties in Kotlin.- Returns:
- possible object is
Boolean
-
setImplicitJoinPathsAsKotlinProperties
Whether implicit join path constructors should be offered as properties in Kotlin.- Parameters:
value- allowed object isBoolean
-
isDeprecated
Generate deprecated code for backwards compatibility- Returns:
- possible object is
Boolean
-
setDeprecated
Generate deprecated code for backwards compatibility- Parameters:
value- allowed object isBoolean
-
isDeprecationOnUnknownTypes
Generate deprecation annotations on references to unknown data types. This helps to identify columns, attributes, and parameters, which may not be usable through jOOQ API, without adding custom data type bindings to them.- Returns:
- possible object is
Boolean
-
setDeprecationOnUnknownTypes
Generate deprecation annotations on references to unknown data types. This helps to identify columns, attributes, and parameters, which may not be usable through jOOQ API, without adding custom data type bindings to them.- Parameters:
value- allowed object isBoolean
-
isInstanceFields
Deprecated.- Returns:
- possible object is
Boolean
-
setInstanceFields
Deprecated.- Parameters:
value- allowed object isBoolean
-
getVisibilityModifier
The visibility modifier to be used with generated code. -
setVisibilityModifier
The visibility modifier to be used with generated code. -
isGeneratedAnnotation
Use theGeneratedannotation specified bygetGeneratedAnnotationType()in generated code.- Returns:
- possible object is
Boolean
-
setGeneratedAnnotation
Use theGeneratedannotation specified bygetGeneratedAnnotationType()in generated code.- Parameters:
value- allowed object isBoolean
-
getGeneratedAnnotationType
Specify the type ofGeneratedannotation to use in generated code. -
setGeneratedAnnotationType
Specify the type ofGeneratedannotation to use in generated code. -
isGeneratedAnnotationDate
Whether theGeneratedannotation specified bygetGeneratedAnnotationType()should include thedateattribute.- Returns:
- possible object is
Boolean
-
setGeneratedAnnotationDate
Whether theGeneratedannotation specified bygetGeneratedAnnotationType()should include thedateattribute.- Parameters:
value- allowed object isBoolean
-
isGeneratedAnnotationJooqVersion
Whether theGeneratedannotation specified bygetGeneratedAnnotationType()should include the jOOQ version.- Returns:
- possible object is
Boolean
-
setGeneratedAnnotationJooqVersion
Whether theGeneratedannotation specified bygetGeneratedAnnotationType()should include the jOOQ version.- Parameters:
value- allowed object isBoolean
-
isNonnullAnnotation
Whether non-nullable items should be annotated with the annotation type specified innonnullAnnotationType. In SQL and by consequence in jOOQ, non-nullability cannot be guaranteed statically. There may still be some cases (e.g. after unions, outer joins, etc.) where a normally non-null value turns out to be null!- Returns:
- possible object is
Boolean
-
setNonnullAnnotation
Whether non-nullable items should be annotated with the annotation type specified innonnullAnnotationType. In SQL and by consequence in jOOQ, non-nullability cannot be guaranteed statically. There may still be some cases (e.g. after unions, outer joins, etc.) where a normally non-null value turns out to be null!- Parameters:
value- allowed object isBoolean
-
getNonnullAnnotationType
Specify the qualified annotation name for all non-nullable items in generated code, defaulting to the JSR-305type.invalid reference
javax.annotation.Nonnull -
setNonnullAnnotationType
Specify the qualified annotation name for all non-nullable items in generated code, defaulting to the JSR-305type.invalid reference
javax.annotation.Nonnull -
isNullableAnnotation
Whether nullable items should be annotated with the annotation type specified innullableAnnotationType. UnlikenonnullAnnotation, nullability can be guaranteed as in SQL, and by consequence in jOOQ, every column expression can be made nullable using some SQL operation.- Returns:
- possible object is
Boolean
-
setNullableAnnotation
Whether nullable items should be annotated with the annotation type specified innullableAnnotationType. UnlikenonnullAnnotation, nullability can be guaranteed as in SQL, and by consequence in jOOQ, every column expression can be made nullable using some SQL operation.- Parameters:
value- allowed object isBoolean
-
isNullableAnnotationOnWriteOnlyNullableTypes
Whether write-only (e.g. defaulted, non-null) nullable items should be annotated with the annotation type specified innullableAnnotationType. UnlikenonnullAnnotation, nullability can be guaranteed as in SQL, and by consequence in jOOQ, every column expression can be made nullable using some SQL operation.- Returns:
- possible object is
Boolean
-
setNullableAnnotationOnWriteOnlyNullableTypes
Whether write-only (e.g. defaulted, non-null) nullable items should be annotated with the annotation type specified innullableAnnotationType. UnlikenonnullAnnotation, nullability can be guaranteed as in SQL, and by consequence in jOOQ, every column expression can be made nullable using some SQL operation.- Parameters:
value- allowed object isBoolean
-
getNullableAnnotationType
Specify the qualified annotation name for all nullable items in generated code, defaulting to the JSR-305type.invalid reference
javax.annotation.Nullable -
setNullableAnnotationType
Specify the qualified annotation name for all nullable items in generated code, defaulting to the JSR-305type.invalid reference
javax.annotation.Nullable -
isConstructorPropertiesAnnotation
Generate theConstructorPropertiesannotation on generated POJOs and/or records.- Returns:
- possible object is
Boolean
-
setConstructorPropertiesAnnotation
Generate theConstructorPropertiesannotation on generated POJOs and/or records.- Parameters:
value- allowed object isBoolean
-
isConstructorPropertiesAnnotationOnPojos
Generate theConstructorPropertiesannotation on generated POJOs (defaults totrueifconstructorPropertiesAnnotationis active).- Returns:
- possible object is
Boolean
-
setConstructorPropertiesAnnotationOnPojos
Generate theConstructorPropertiesannotation on generated POJOs (defaults totrueifconstructorPropertiesAnnotationis active).- Parameters:
value- allowed object isBoolean
-
isConstructorPropertiesAnnotationOnRecords
Generate theConstructorPropertiesannotation on generated records (defaults totrueifconstructorPropertiesAnnotationis active).- Returns:
- possible object is
Boolean
-
setConstructorPropertiesAnnotationOnRecords
Generate theConstructorPropertiesannotation on generated records (defaults totrueifconstructorPropertiesAnnotationis active).- Parameters:
value- allowed object isBoolean
-
isRoutines
Generate Routine classes.- Returns:
- possible object is
Boolean
-
setRoutines
Generate Routine classes.- Parameters:
value- allowed object isBoolean
-
isSequences
Generate Sequence classes.- Returns:
- possible object is
Boolean
-
setSequences
Generate Sequence classes.- Parameters:
value- allowed object isBoolean
-
isTriggers
Generate Trigger classes.- Returns:
- possible object is
Boolean
-
setTriggers
Generate Trigger classes.- Parameters:
value- allowed object isBoolean
-
isSynonyms
Generate Synonym classes.- Returns:
- possible object is
Boolean
-
setSynonyms
Generate Synonym classes.- Parameters:
value- allowed object isBoolean
-
isUdts
Generate UDT classes.- Returns:
- possible object is
Boolean
-
setUdts
Generate UDT classes.- Parameters:
value- allowed object isBoolean
-
isQueues
Generate Queue classes.- Returns:
- possible object is
Boolean
-
setQueues
Generate Queue classes.- Parameters:
value- allowed object isBoolean
-
isLinks
Generate database Link classes.- Returns:
- possible object is
Boolean
-
setLinks
Generate database Link classes.- Parameters:
value- allowed object isBoolean
-
isKeys
Generate Key classes.- Returns:
- possible object is
Boolean
-
setKeys
Generate Key classes.- Parameters:
value- allowed object isBoolean
-
isTables
Generate Table classes.- Returns:
- possible object is
Boolean
-
setTables
Generate Table classes.- Parameters:
value- allowed object isBoolean
-
isEmbeddables
Generate embeddable classes.- Returns:
- possible object is
Boolean
-
setEmbeddables
Generate embeddable classes.- Parameters:
value- allowed object isBoolean
-
isRecords
Generate TableRecord classes.- Returns:
- possible object is
Boolean
-
setRecords
Generate TableRecord classes.- Parameters:
value- allowed object isBoolean
-
getRecordsIncludes
All the object identifiers for which to generate records, by default, all of them.This is a Java regular expression. Use the pipe to separate several expressions. Watch out for case-sensitivity. Depending on your database, this might be important!
You can create case-insensitive regular expressions using this syntax:
(?i:expr)Whitespace is ignored and comments are possible unless overridden in
.invalid reference
#getRegexFlags() -
setRecordsIncludes
All the object identifiers for which to generate records, by default, all of them.This is a Java regular expression. Use the pipe to separate several expressions. Watch out for case-sensitivity. Depending on your database, this might be important!
You can create case-insensitive regular expressions using this syntax:
(?i:expr)Whitespace is ignored and comments are possible unless overridden in
.invalid reference
#getRegexFlags() -
getRecordsExcludes
All the object identifiers for which not to generate records.This is a Java regular expression. Use the pipe to separate several expressions. Watch out for case-sensitivity. Depending on your database, this might be important!
You can create case-insensitive regular expressions using this syntax:
(?i:expr)Whitespace is ignored and comments are possible unless overridden in
.invalid reference
#getRegexFlags() -
setRecordsExcludes
All the object identifiers for which not to generate records.This is a Java regular expression. Use the pipe to separate several expressions. Watch out for case-sensitivity. Depending on your database, this might be important!
You can create case-insensitive regular expressions using this syntax:
(?i:expr)Whitespace is ignored and comments are possible unless overridden in
.invalid reference
#getRegexFlags() -
isRecordsImplementingRecordN
Generate TableRecord classes that implement Record[N] super types- Returns:
- possible object is
Boolean
-
setRecordsImplementingRecordN
Generate TableRecord classes that implement Record[N] super types- Parameters:
value- allowed object isBoolean
-
isEnumsAsScalaSealedTraits
Deprecated.Activate the legacy Scala sealed trait enum emulation- Returns:
- possible object is
Boolean
-
setEnumsAsScalaSealedTraits
Deprecated.Activate the legacy Scala sealed trait enum emulation- Parameters:
value- allowed object isBoolean
-
isEnumsAsScalaEnums
Generate enums as Scala 3.0 enums (if Scala 3 is supported).- Returns:
- possible object is
Boolean
-
setEnumsAsScalaEnums
Generate enums as Scala 3.0 enums (if Scala 3 is supported).- Parameters:
value- allowed object isBoolean
-
isPojos
Generate POJOs.- Returns:
- possible object is
Boolean
-
setPojos
Generate POJOs.- Parameters:
value- allowed object isBoolean
-
getPojosIncludes
All the object identifiers for which to generate POJOs, by default, all of them.This is a Java regular expression. Use the pipe to separate several expressions. Watch out for case-sensitivity. Depending on your database, this might be important!
You can create case-insensitive regular expressions using this syntax:
(?i:expr)Whitespace is ignored and comments are possible unless overridden in
.invalid reference
#getRegexFlags() -
setPojosIncludes
All the object identifiers for which to generate POJOs, by default, all of them.This is a Java regular expression. Use the pipe to separate several expressions. Watch out for case-sensitivity. Depending on your database, this might be important!
You can create case-insensitive regular expressions using this syntax:
(?i:expr)Whitespace is ignored and comments are possible unless overridden in
.invalid reference
#getRegexFlags() -
getPojosExcludes
All the object identifiers for which not to generate POJOs.This is a Java regular expression. Use the pipe to separate several expressions. Watch out for case-sensitivity. Depending on your database, this might be important!
You can create case-insensitive regular expressions using this syntax:
(?i:expr)Whitespace is ignored and comments are possible unless overridden in
.invalid reference
#getRegexFlags() -
setPojosExcludes
All the object identifiers for which not to generate POJOs.This is a Java regular expression. Use the pipe to separate several expressions. Watch out for case-sensitivity. Depending on your database, this might be important!
You can create case-insensitive regular expressions using this syntax:
(?i:expr)Whitespace is ignored and comments are possible unless overridden in
.invalid reference
#getRegexFlags() -
isPojosEqualsAndHashCode
Generate basic equals() and hashCode() methods in POJOs.- Returns:
- possible object is
Boolean
-
setPojosEqualsAndHashCode
Generate basic equals() and hashCode() methods in POJOs.- Parameters:
value- allowed object isBoolean
-
isPojosEqualsAndHashCodeIncludePrimaryKeyOnly
Include primary key columns only in generated equals() and hashCode() methods in POJOs.- Returns:
- possible object is
Boolean
-
setPojosEqualsAndHashCodeIncludePrimaryKeyOnly
Include primary key columns only in generated equals() and hashCode() methods in POJOs.- Parameters:
value- allowed object isBoolean
-
getPojosEqualsAndHashCodeColumnIncludeExpression
A regular expression matching columns for inclusion in generated equals() and hashCode() methods in POJOs. -
setPojosEqualsAndHashCodeColumnIncludeExpression
A regular expression matching columns for inclusion in generated equals() and hashCode() methods in POJOs. -
getPojosEqualsAndHashCodeColumnExcludeExpression
A regular expression matching columns for exclusion in generated equals() and hashCode() methods in POJOs. -
setPojosEqualsAndHashCodeColumnExcludeExpression
A regular expression matching columns for exclusion in generated equals() and hashCode() methods in POJOs. -
isPojosToString
Generate basic toString() methods in POJOs.- Returns:
- possible object is
Boolean
-
setPojosToString
Generate basic toString() methods in POJOs.- Parameters:
value- allowed object isBoolean
-
isPojosAsJavaRecordClasses
Generate POJOs as records, when using the JavaGenerator.- Returns:
- possible object is
Boolean
-
setPojosAsJavaRecordClasses
Generate POJOs as records, when using the JavaGenerator.- Parameters:
value- allowed object isBoolean
-
isPojosAsScalaCaseClasses
Generate POJOs as case classes, when using the ScalaGenerator or Scala3Generator.- Returns:
- possible object is
Boolean
-
setPojosAsScalaCaseClasses
Generate POJOs as case classes, when using the ScalaGenerator or Scala3Generator.- Parameters:
value- allowed object isBoolean
-
isPojosAsKotlinDataClasses
Generate POJOs as data classes, when using the KotlinGenerator.- Returns:
- possible object is
Boolean
-
setPojosAsKotlinDataClasses
Generate POJOs as data classes, when using the KotlinGenerator.- Parameters:
value- allowed object isBoolean
-
isImmutablePojos
Generate immutable POJOs.- Returns:
- possible object is
Boolean
-
setImmutablePojos
Generate immutable POJOs.- Parameters:
value- allowed object isBoolean
-
isSerializablePojos
Generate serializable POJOs.- Returns:
- possible object is
Boolean
-
setSerializablePojos
Generate serializable POJOs.- Parameters:
value- allowed object isBoolean
-
isInterfaces
Generated interfaces to be implemented by records and/or POJOs.- Returns:
- possible object is
Boolean
-
setInterfaces
Generated interfaces to be implemented by records and/or POJOs.- Parameters:
value- allowed object isBoolean
-
isImmutableInterfaces
Generate immutable interfaces.- Returns:
- possible object is
Boolean
-
setImmutableInterfaces
Generate immutable interfaces.- Parameters:
value- allowed object isBoolean
-
isSerializableInterfaces
Generate serializable interfaces.- Returns:
- possible object is
Boolean
-
setSerializableInterfaces
Generate serializable interfaces.- Parameters:
value- allowed object isBoolean
-
isDaos
Generate DAOs.- Returns:
- possible object is
Boolean
-
setDaos
Generate DAOs.- Parameters:
value- allowed object isBoolean
-
getDaosIncludes
All the object identifiers for which to generate DAOs, by default, all of them.This is a Java regular expression. Use the pipe to separate several expressions. Watch out for case-sensitivity. Depending on your database, this might be important!
You can create case-insensitive regular expressions using this syntax:
(?i:expr)Whitespace is ignored and comments are possible unless overridden in
.invalid reference
#getRegexFlags() -
setDaosIncludes
All the object identifiers for which to generate DAOs, by default, all of them.This is a Java regular expression. Use the pipe to separate several expressions. Watch out for case-sensitivity. Depending on your database, this might be important!
You can create case-insensitive regular expressions using this syntax:
(?i:expr)Whitespace is ignored and comments are possible unless overridden in
.invalid reference
#getRegexFlags() -
getDaosExcludes
All the object identifiers for which not to generate DAOs.This is a Java regular expression. Use the pipe to separate several expressions. Watch out for case-sensitivity. Depending on your database, this might be important!
You can create case-insensitive regular expressions using this syntax:
(?i:expr)Whitespace is ignored and comments are possible unless overridden in
.invalid reference
#getRegexFlags() -
setDaosExcludes
All the object identifiers for which not to generate DAOs.This is a Java regular expression. Use the pipe to separate several expressions. Watch out for case-sensitivity. Depending on your database, this might be important!
You can create case-insensitive regular expressions using this syntax:
(?i:expr)Whitespace is ignored and comments are possible unless overridden in
.invalid reference
#getRegexFlags() -
isJooqVersionReference
Generate references to the most up to date minor release inConstantsto produce compilation errors if an outdated runtime library is being used.- Returns:
- possible object is
Boolean
-
setJooqVersionReference
Generate references to the most up to date minor release inConstantsto produce compilation errors if an outdated runtime library is being used.- Parameters:
value- allowed object isBoolean
-
isJpaAnnotations
Annotate POJOs and Records with JPA annotations.- Returns:
- possible object is
Boolean
-
setJpaAnnotations
Annotate POJOs and Records with JPA annotations.- Parameters:
value- allowed object isBoolean
-
getJpaVersion
Version of JPA specification is to be used to generate version-specific annotations. If it is omitted, the latest version is used by default. -
setJpaVersion
Version of JPA specification is to be used to generate version-specific annotations. If it is omitted, the latest version is used by default. -
isValidationAnnotations
Annotate POJOs and Records with JSR-303 validation annotations- Returns:
- possible object is
Boolean
-
setValidationAnnotations
Annotate POJOs and Records with JSR-303 validation annotations- Parameters:
value- allowed object isBoolean
-
isSpringAnnotations
Annotate DAOs with useful spring annotations such as @Repository or @Autowired.- Returns:
- possible object is
Boolean
-
setSpringAnnotations
Annotate DAOs with useful spring annotations such as @Repository or @Autowired.- Parameters:
value- allowed object isBoolean
-
isSpringDao
Generate an AbstractSpringDAOImpl as a base class for other DAO classes, containing @Transactional annotations, etc.- Returns:
- possible object is
Boolean
-
setSpringDao
Generate an AbstractSpringDAOImpl as a base class for other DAO classes, containing @Transactional annotations, etc.- Parameters:
value- allowed object isBoolean
-
isKotlinSetterJvmNameAnnotationsOnIsPrefix
Workaround for Kotlin generatingsetX()setters instead ofsetIsX()in byte code for mutable properties calledisX.- Returns:
- possible object is
Boolean
-
setKotlinSetterJvmNameAnnotationsOnIsPrefix
Workaround for Kotlin generatingsetX()setters instead ofsetIsX()in byte code for mutable properties calledisX.- Parameters:
value- allowed object isBoolean
-
isKotlinNotNullPojoAttributes
Generate non-nullable types on POJO attributes, where column is not null.- Returns:
- possible object is
Boolean
-
setKotlinNotNullPojoAttributes
Generate non-nullable types on POJO attributes, where column is not null.- Parameters:
value- allowed object isBoolean
-
isKotlinNotNullRecordAttributes
Generate non-nullable types on Record attributes, where column is not null.- Returns:
- possible object is
Boolean
-
setKotlinNotNullRecordAttributes
Generate non-nullable types on Record attributes, where column is not null.- Parameters:
value- allowed object isBoolean
-
isKotlinNotNullInterfaceAttributes
Generate non-nullable types on interface attributes, where column is not null.- Returns:
- possible object is
Boolean
-
setKotlinNotNullInterfaceAttributes
Generate non-nullable types on interface attributes, where column is not null.- Parameters:
value- allowed object isBoolean
-
isKotlinDefaultedNullablePojoAttributes
Generate defaulted nullable POJO attributes.- Returns:
- possible object is
Boolean
-
setKotlinDefaultedNullablePojoAttributes
Generate defaulted nullable POJO attributes.- Parameters:
value- allowed object isBoolean
-
isKotlinDefaultedNullableRecordAttributes
Generate defaulted nullable Record attributes.- Returns:
- possible object is
Boolean
-
setKotlinDefaultedNullableRecordAttributes
Generate defaulted nullable Record attributes.- Parameters:
value- allowed object isBoolean
-
isGlobalObjectNames
Turn on generation of all global object names.- Returns:
- possible object is
Boolean
-
setGlobalObjectNames
Turn on generation of all global object names.- Parameters:
value- allowed object isBoolean
-
isGlobalObjectReferences
Turn off generation of all global object references.- Returns:
- possible object is
Boolean
-
setGlobalObjectReferences
Turn off generation of all global object references.- Parameters:
value- allowed object isBoolean
-
isGlobalCatalogReferences
Turn off generation of global catalog references.- Returns:
- possible object is
Boolean
-
setGlobalCatalogReferences
Turn off generation of global catalog references.- Parameters:
value- allowed object isBoolean
-
isGlobalSchemaReferences
Turn off generation of global schema references.- Returns:
- possible object is
Boolean
-
setGlobalSchemaReferences
Turn off generation of global schema references.- Parameters:
value- allowed object isBoolean
-
isGlobalDomainReferences
Turn off generation of global domain references.- Returns:
- possible object is
Boolean
-
setGlobalDomainReferences
Turn off generation of global domain references.- Parameters:
value- allowed object isBoolean
-
isGlobalTriggerReferences
Turn off generation of global trigger references.- Returns:
- possible object is
Boolean
-
setGlobalTriggerReferences
Turn off generation of global trigger references.- Parameters:
value- allowed object isBoolean
-
isGlobalSynonymReferences
Turn off generation of global synonym references.- Returns:
- possible object is
Boolean
-
setGlobalSynonymReferences
Turn off generation of global synonym references.- Parameters:
value- allowed object isBoolean
-
isGlobalTableReferences
Turn off generation of global table references.- Returns:
- possible object is
Boolean
-
setGlobalTableReferences
Turn off generation of global table references.- Parameters:
value- allowed object isBoolean
-
isGlobalSequenceReferences
Turn off generation of global sequence references.- Returns:
- possible object is
Boolean
-
setGlobalSequenceReferences
Turn off generation of global sequence references.- Parameters:
value- allowed object isBoolean
-
isGlobalUDTReferences
Turn off generation of global UDT references.- Returns:
- possible object is
Boolean
-
setGlobalUDTReferences
Turn off generation of global UDT references.- Parameters:
value- allowed object isBoolean
-
isGlobalRoutineReferences
Turn off generation of global routine references.- Returns:
- possible object is
Boolean
-
setGlobalRoutineReferences
Turn off generation of global routine references.- Parameters:
value- allowed object isBoolean
-
isGlobalQueueReferences
Turn off generation of global queue references.- Returns:
- possible object is
Boolean
-
setGlobalQueueReferences
Turn off generation of global queue references.- Parameters:
value- allowed object isBoolean
-
isGlobalLinkReferences
Turn off generation of global database link references.- Returns:
- possible object is
Boolean
-
setGlobalLinkReferences
Turn off generation of global database link references.- Parameters:
value- allowed object isBoolean
-
isGlobalKeyReferences
Turn off generation of global key references.- Returns:
- possible object is
Boolean
-
setGlobalKeyReferences
Turn off generation of global key references.- Parameters:
value- allowed object isBoolean
-
isGlobalIndexReferences
Turn off generation of global index references.- Returns:
- possible object is
Boolean
-
setGlobalIndexReferences
Turn off generation of global index references.- Parameters:
value- allowed object isBoolean
-
isDefaultCatalog
Turn off generation of aDefaultCatalogobject, which is generated by default in the absence of catalogs.- Returns:
- possible object is
Boolean
-
setDefaultCatalog
Turn off generation of aDefaultCatalogobject, which is generated by default in the absence of catalogs.- Parameters:
value- allowed object isBoolean
-
isDefaultSchema
Turn off generation of aDefaultSchemaobject, which is generated by default in the absence of schemas.- Returns:
- possible object is
Boolean
-
setDefaultSchema
Turn off generation of aDefaultSchemaobject, which is generated by default in the absence of schemas.- Parameters:
value- allowed object isBoolean
-
isJavadoc
Turn off generation of Javadoc on all objects.- Returns:
- possible object is
Boolean
-
setJavadoc
Turn off generation of Javadoc on all objects.- Parameters:
value- allowed object isBoolean
-
isComments
Turn off generation of all SQL comments as Javadoc on all objects.- Returns:
- possible object is
Boolean
-
setComments
Turn off generation of all SQL comments as Javadoc on all objects.- Parameters:
value- allowed object isBoolean
-
isCommentsOnCatalogs
Turn off generation of all SQL comments as Javadoc on all catalogs.- Returns:
- possible object is
Boolean
-
setCommentsOnCatalogs
Turn off generation of all SQL comments as Javadoc on all catalogs.- Parameters:
value- allowed object isBoolean
-
isCommentsOnSchemas
Turn off generation of all SQL comments as Javadoc on all schemas.- Returns:
- possible object is
Boolean
-
setCommentsOnSchemas
Turn off generation of all SQL comments as Javadoc on all schemas.- Parameters:
value- allowed object isBoolean
-
isCommentsOnTables
Turn off generation of all SQL comments as Javadoc on all tables.- Returns:
- possible object is
Boolean
-
setCommentsOnTables
Turn off generation of all SQL comments as Javadoc on all tables.- Parameters:
value- allowed object isBoolean
-
isCommentsOnColumns
Turn off generation of all SQL comments as Javadoc on all columns.- Returns:
- possible object is
Boolean
-
setCommentsOnColumns
Turn off generation of all SQL comments as Javadoc on all columns.- Parameters:
value- allowed object isBoolean
-
isCommentsOnEmbeddables
Turn off generation of all SQL comments as Javadoc on all embeddables.- Returns:
- possible object is
Boolean
-
setCommentsOnEmbeddables
Turn off generation of all SQL comments as Javadoc on all embeddables.- Parameters:
value- allowed object isBoolean
-
isCommentsOnUDTs
Turn off generation of all SQL comments as Javadoc on all UDTs.- Returns:
- possible object is
Boolean
-
setCommentsOnUDTs
Turn off generation of all SQL comments as Javadoc on all UDTs.- Parameters:
value- allowed object isBoolean
-
isCommentsOnAttributes
Turn off generation of all SQL comments as Javadoc on all attributes.- Returns:
- possible object is
Boolean
-
setCommentsOnAttributes
Turn off generation of all SQL comments as Javadoc on all attributes.- Parameters:
value- allowed object isBoolean
-
isCommentsOnPackages
Turn off generation of all SQL comments as Javadoc on all packages.- Returns:
- possible object is
Boolean
-
setCommentsOnPackages
Turn off generation of all SQL comments as Javadoc on all packages.- Parameters:
value- allowed object isBoolean
-
isCommentsOnRoutines
Turn off generation of all SQL comments as Javadoc on all routines.- Returns:
- possible object is
Boolean
-
setCommentsOnRoutines
Turn off generation of all SQL comments as Javadoc on all routines.- Parameters:
value- allowed object isBoolean
-
isCommentsOnParameters
Turn off generation of all SQL comments as Javadoc on all parameters.- Returns:
- possible object is
Boolean
-
setCommentsOnParameters
Turn off generation of all SQL comments as Javadoc on all parameters.- Parameters:
value- allowed object isBoolean
-
isCommentsOnSequences
Turn off generation of all SQL comments as Javadoc on all sequences.- Returns:
- possible object is
Boolean
-
setCommentsOnSequences
Turn off generation of all SQL comments as Javadoc on all sequences.- Parameters:
value- allowed object isBoolean
-
isCommentsOnDomains
Turn off generation of all SQL comments as Javadoc on all domains.- Returns:
- possible object is
Boolean
-
setCommentsOnDomains
Turn off generation of all SQL comments as Javadoc on all domains.- Parameters:
value- allowed object isBoolean
-
isCommentsOnLinks
Turn off generation of all SQL comments as Javadoc on all links.- Returns:
- possible object is
Boolean
-
setCommentsOnLinks
Turn off generation of all SQL comments as Javadoc on all links.- Parameters:
value- allowed object isBoolean
-
isCommentsOnQueues
Turn off generation of all SQL comments as Javadoc on all queues.- Returns:
- possible object is
Boolean
-
setCommentsOnQueues
Turn off generation of all SQL comments as Javadoc on all queues.- Parameters:
value- allowed object isBoolean
-
isCommentsOnKeys
Turn off generation of all SQL comments as Javadoc on all keys.- Returns:
- possible object is
Boolean
-
setCommentsOnKeys
Turn off generation of all SQL comments as Javadoc on all keys.- Parameters:
value- allowed object isBoolean
-
isSources
Turn off generation of all source code on all object types.- Returns:
- possible object is
Boolean
-
setSources
Turn off generation of all source code on all object types.- Parameters:
value- allowed object isBoolean
-
isSourcesOnViews
Turn off generation of all source code on all views.- Returns:
- possible object is
Boolean
-
setSourcesOnViews
Turn off generation of all source code on all views.- Parameters:
value- allowed object isBoolean
-
isFluentSetters
Generate fluent setters in records, POJOs, interfaces.- Returns:
- possible object is
Boolean
-
setFluentSetters
Generate fluent setters in records, POJOs, interfaces.- Parameters:
value- allowed object isBoolean
-
isJavaBeansGettersAndSetters
Modify DefaultGeneratorStrategy behaviour to generate getters and setters in JavaBeans style in records, POJOs, interfaces.If this flag is set to false, then:
- Column name : X_INDEX
- Attribute name: xIndex
- Getter name : getXIndex()
- Setter name : setXIndex()
If this flag is set to true, then:
- Getter name : getxIndex()
- Setter name : setxIndex()
Custom GeneratorStrategy implementations are unaffected
- Returns:
- possible object is
Boolean
-
setJavaBeansGettersAndSetters
Modify DefaultGeneratorStrategy behaviour to generate getters and setters in JavaBeans style in records, POJOs, interfaces.If this flag is set to false, then:
- Column name : X_INDEX
- Attribute name: xIndex
- Getter name : getXIndex()
- Setter name : setXIndex()
If this flag is set to true, then:
- Getter name : getxIndex()
- Setter name : setxIndex()
Custom GeneratorStrategy implementations are unaffected
- Parameters:
value- allowed object isBoolean
-
isVarargSetters
Generate varargs setters for array types for convenience.This may lead to compilation warnings in current Java versions.
- Returns:
- possible object is
Boolean
-
setVarargSetters
Generate varargs setters for array types for convenience.This may lead to compilation warnings in current Java versions.
- Parameters:
value- allowed object isBoolean
-
getGeneratedSerialVersionUID
The serial version UID to be generated in all files. -
setGeneratedSerialVersionUID
The serial version UID to be generated in all files. -
getMaxMembersPerInitialiser
The maximum number of members per initialiser, to prevent reaching the 64kb byte code per method limit in generated code. -
setMaxMembersPerInitialiser
The maximum number of members per initialiser, to prevent reaching the 64kb byte code per method limit in generated code. -
getFullyQualifiedTypes
A regular expression matching all the types in generated code that should be fully qualified.This can be useful if you have a database object that generates a String class, and you want to avoid naming clashes with the java.lang package by specifying
java\.lang\..* -
setFullyQualifiedTypes
A regular expression matching all the types in generated code that should be fully qualified.This can be useful if you have a database object that generates a String class, and you want to avoid naming clashes with the java.lang package by specifying
java\.lang\..* -
isEmptyCatalogs
Whether empty catalogs (e.g. empty because ofconfigurations) should still be generated. - Returns:
- possible object is
Boolean
-
setEmptyCatalogs
Whether empty catalogs (e.g. empty because ofconfigurations) should still be generated. - Parameters:
value- allowed object isBoolean
-
isEmptySchemas
Whether empty schemas (e.g. empty because ofconfigurations) should still be generated. - Returns:
- possible object is
Boolean
-
setEmptySchemas
Whether empty schemas (e.g. empty because ofconfigurations) should still be generated. - Parameters:
value- allowed object isBoolean
-
isJavaTimeTypes
A flag indicating whether Java 8's java.time types should be used by the source code generator, rather than JDBC's java.sql types.This flag is ignored in the commercial Java 6 distribution of jOOQ 3.9+
- Returns:
- possible object is
Boolean
-
setJavaTimeTypes
A flag indicating whether Java 8's java.time types should be used by the source code generator, rather than JDBC's java.sql types.This flag is ignored in the commercial Java 6 distribution of jOOQ 3.9+
- Parameters:
value- allowed object isBoolean
-
isSpatialTypes
A flag indicating whether the spatial type support should be enabled.- Returns:
- possible object is
Boolean
-
setSpatialTypes
A flag indicating whether the spatial type support should be enabled.- Parameters:
value- allowed object isBoolean
-
isXmlTypes
A flag indicating whether the XML type support should be enabled.- Returns:
- possible object is
Boolean
-
setXmlTypes
A flag indicating whether the XML type support should be enabled.- Parameters:
value- allowed object isBoolean
-
isJsonTypes
A flag indicating whether the JSON type support should be enabled.- Returns:
- possible object is
Boolean
-
setJsonTypes
A flag indicating whether the JSON type support should be enabled.- Parameters:
value- allowed object isBoolean
-
isIntervalTypes
A flag indicating whether the INTERVAL type support should be enabled.- Returns:
- possible object is
Boolean
-
setIntervalTypes
A flag indicating whether the INTERVAL type support should be enabled.- Parameters:
value- allowed object isBoolean
-
isDecfloatTypes
A flag indicating whether the DECFLOAT type support should be enabled.- Returns:
- possible object is
Boolean
-
setDecfloatTypes
A flag indicating whether the DECFLOAT type support should be enabled.- Parameters:
value- allowed object isBoolean
-
getNewline
The newline characters to be used in generated code. Whitespace characters can be used, e.g. \n, \r\n -
setNewline
The newline characters to be used in generated code. Whitespace characters can be used, e.g. \n, \r\n -
getIndentation
The indentation characters to be used in generated code. If unspecified, an idiomatic default indentation of the language will be used (4 spaces in Java, 2 spaces in Scala). Whitespace characters can be used, e.g. \t -
setIndentation
The indentation characters to be used in generated code. If unspecified, an idiomatic default indentation of the language will be used (4 spaces in Java, 2 spaces in Scala). Whitespace characters can be used, e.g. \t -
getPrintMarginForBlockComment
The print margin to apply to generated Javadoc and other block comments, for automatic line wrapping. The feature is turned off if the print margin is0. -
setPrintMarginForBlockComment
The print margin to apply to generated Javadoc and other block comments, for automatic line wrapping. The feature is turned off if the print margin is0. -
getTextBlocks
Whether to generate String in text block format. -
setTextBlocks
Whether to generate String in text block format. -
isWhereMethodOverrides
Whether to generate overrides forTable.where(org.jooq.Condition)and related overloads.- Returns:
- possible object is
Boolean
-
setWhereMethodOverrides
Whether to generate overrides forTable.where(org.jooq.Condition)and related overloads.- Parameters:
value- allowed object isBoolean
-
isRenameMethodOverrides
Whether to generate overrides (see https://github.com/jOOQ/jOOQ/issues/13937) forand related overloads.invalid reference
org.jooq.Table#rename(org.jooq.Name)- Returns:
- possible object is
Boolean
-
setRenameMethodOverrides
Whether to generate overrides (see https://github.com/jOOQ/jOOQ/issues/13937) forand related overloads.invalid reference
org.jooq.Table#rename(org.jooq.Name)- Parameters:
value- allowed object isBoolean
-
isAsMethodOverrides
Whether to generate overrides forTable.as(org.jooq.Name)and related overloads.- Returns:
- possible object is
Boolean
-
setAsMethodOverrides
Whether to generate overrides forTable.as(org.jooq.Name)and related overloads.- Parameters:
value- allowed object isBoolean
-
isHiddenColumnsInRecords
Whether hidden columns should be generated in records.This feature is available in the commercial distribution only.
- Returns:
- possible object is
Boolean
-
setHiddenColumnsInRecords
Whether hidden columns should be generated in records.This feature is available in the commercial distribution only.
- Parameters:
value- allowed object isBoolean
-
isHiddenColumnsInPojos
Whether hidden columns should be generated in POJOs.This feature is available in the commercial distribution only.
- Returns:
- possible object is
Boolean
-
setHiddenColumnsInPojos
Whether hidden columns should be generated in POJOs.This feature is available in the commercial distribution only.
- Parameters:
value- allowed object isBoolean
-
isHiddenColumnsInInterfaces
Whether hidden columns should be generated in interfaces.This feature is available in the commercial distribution only.
- Returns:
- possible object is
Boolean
-
setHiddenColumnsInInterfaces
Whether hidden columns should be generated in interfaces.This feature is available in the commercial distribution only.
- Parameters:
value- allowed object isBoolean
-
withIndexes
Generate index information. -
withRelations
Primary key / foreign key relations should be generated and used. This is a prerequisite for various advanced features -
withSequenceFlags
Sequence flags should be generated and used. -
withUdtPaths
Generate UDT path expressions on tables and on UDTs. -
withImplicitJoinPathsToOne
Generate implicit join path constructors on generated tables for outgoing foreign key relationships (to-one relationships) -
withImplicitJoinPathsToMany
Generate implicit join path constructors on generated tables for incoming foreign key relationships (to-many relationships) -
withImplicitJoinPathsManyToMany
Generate implicit join path constructors on generated tables for many-to-many relationships. This turns off implicitly, if either of the other path generations are turned off. -
withImplicitJoinPathTableSubtypes
Generate implicit join path table subtypes implementingPathfor increased JOIN convenience. -
withImplicitJoinPathUnusedConstructors
Generate implicit join path constructors also if there isn't any outgoing or incoming foreign key relationship. -
withImplicitJoinPathsUseTableNameForUnambiguousFKs
Whether names of unambiguousForeignKeyDefinitionshould be based on the referencedTableDefinition.When a child table has only one
ForeignKeyDefinitiontowards a parent table, then that path is "unambiguous." In that case, someimplementations may choose to use the parent table'sinvalid reference
GeneratorStrategyTableDefinitionfor implementations of, instead of theinvalid reference
org.jooq.codegen.GeneratorStrategy#getJavaMethodName(Definition)ForeignKeyDefinition, e.g. for implicit join paths.This flag allows for turning off this default behaviour.
-
withImplicitJoinPathsAsKotlinProperties
Whether implicit join path constructors should be offered as properties in Kotlin. -
withDeprecated
Generate deprecated code for backwards compatibility -
withDeprecationOnUnknownTypes
Generate deprecation annotations on references to unknown data types. This helps to identify columns, attributes, and parameters, which may not be usable through jOOQ API, without adding custom data type bindings to them. -
withInstanceFields
Deprecated. -
withVisibilityModifier
The visibility modifier to be used with generated code. -
withGeneratedAnnotation
Use theGeneratedannotation specified bygetGeneratedAnnotationType()in generated code. -
withGeneratedAnnotationType
Specify the type ofGeneratedannotation to use in generated code. -
withGeneratedAnnotationDate
Whether theGeneratedannotation specified bygetGeneratedAnnotationType()should include thedateattribute. -
withGeneratedAnnotationJooqVersion
Whether theGeneratedannotation specified bygetGeneratedAnnotationType()should include the jOOQ version. -
withNonnullAnnotation
Whether non-nullable items should be annotated with the annotation type specified innonnullAnnotationType. In SQL and by consequence in jOOQ, non-nullability cannot be guaranteed statically. There may still be some cases (e.g. after unions, outer joins, etc.) where a normally non-null value turns out to be null! -
withNonnullAnnotationType
Specify the qualified annotation name for all non-nullable items in generated code, defaulting to the JSR-305type.invalid reference
javax.annotation.Nonnull -
withNullableAnnotation
Whether nullable items should be annotated with the annotation type specified innullableAnnotationType. UnlikenonnullAnnotation, nullability can be guaranteed as in SQL, and by consequence in jOOQ, every column expression can be made nullable using some SQL operation. -
withNullableAnnotationOnWriteOnlyNullableTypes
Whether write-only (e.g. defaulted, non-null) nullable items should be annotated with the annotation type specified innullableAnnotationType. UnlikenonnullAnnotation, nullability can be guaranteed as in SQL, and by consequence in jOOQ, every column expression can be made nullable using some SQL operation. -
withNullableAnnotationType
Specify the qualified annotation name for all nullable items in generated code, defaulting to the JSR-305type.invalid reference
javax.annotation.Nullable -
withConstructorPropertiesAnnotation
Generate theConstructorPropertiesannotation on generated POJOs and/or records. -
withConstructorPropertiesAnnotationOnPojos
Generate theConstructorPropertiesannotation on generated POJOs (defaults totrueifconstructorPropertiesAnnotationis active). -
withConstructorPropertiesAnnotationOnRecords
Generate theConstructorPropertiesannotation on generated records (defaults totrueifconstructorPropertiesAnnotationis active). -
withRoutines
Generate Routine classes. -
withSequences
Generate Sequence classes. -
withTriggers
Generate Trigger classes. -
withSynonyms
Generate Synonym classes. -
withUdts
Generate UDT classes. -
withQueues
Generate Queue classes. -
withLinks
Generate database Link classes. -
withKeys
Generate Key classes. -
withTables
Generate Table classes. -
withEmbeddables
Generate embeddable classes. -
withRecords
Generate TableRecord classes. -
withRecordsIncludes
All the object identifiers for which to generate records, by default, all of them.This is a Java regular expression. Use the pipe to separate several expressions. Watch out for case-sensitivity. Depending on your database, this might be important!
You can create case-insensitive regular expressions using this syntax:
(?i:expr)Whitespace is ignored and comments are possible unless overridden in
.invalid reference
#getRegexFlags() -
withRecordsExcludes
All the object identifiers for which not to generate records.This is a Java regular expression. Use the pipe to separate several expressions. Watch out for case-sensitivity. Depending on your database, this might be important!
You can create case-insensitive regular expressions using this syntax:
(?i:expr)Whitespace is ignored and comments are possible unless overridden in
.invalid reference
#getRegexFlags() -
withRecordsImplementingRecordN
Generate TableRecord classes that implement Record[N] super types -
withEnumsAsScalaSealedTraits
Deprecated.Activate the legacy Scala sealed trait enum emulation -
withEnumsAsScalaEnums
Generate enums as Scala 3.0 enums (if Scala 3 is supported). -
withPojos
Generate POJOs. -
withPojosIncludes
All the object identifiers for which to generate POJOs, by default, all of them.This is a Java regular expression. Use the pipe to separate several expressions. Watch out for case-sensitivity. Depending on your database, this might be important!
You can create case-insensitive regular expressions using this syntax:
(?i:expr)Whitespace is ignored and comments are possible unless overridden in
.invalid reference
#getRegexFlags() -
withPojosExcludes
All the object identifiers for which not to generate POJOs.This is a Java regular expression. Use the pipe to separate several expressions. Watch out for case-sensitivity. Depending on your database, this might be important!
You can create case-insensitive regular expressions using this syntax:
(?i:expr)Whitespace is ignored and comments are possible unless overridden in
.invalid reference
#getRegexFlags() -
withPojosEqualsAndHashCode
Generate basic equals() and hashCode() methods in POJOs. -
withPojosEqualsAndHashCodeIncludePrimaryKeyOnly
Include primary key columns only in generated equals() and hashCode() methods in POJOs. -
withPojosEqualsAndHashCodeColumnIncludeExpression
A regular expression matching columns for inclusion in generated equals() and hashCode() methods in POJOs. -
withPojosEqualsAndHashCodeColumnExcludeExpression
A regular expression matching columns for exclusion in generated equals() and hashCode() methods in POJOs. -
withPojosToString
Generate basic toString() methods in POJOs. -
withPojosAsJavaRecordClasses
Generate POJOs as records, when using the JavaGenerator. -
withPojosAsScalaCaseClasses
Generate POJOs as case classes, when using the ScalaGenerator or Scala3Generator. -
withPojosAsKotlinDataClasses
Generate POJOs as data classes, when using the KotlinGenerator. -
withImmutablePojos
Generate immutable POJOs. -
withSerializablePojos
Generate serializable POJOs. -
withInterfaces
Generated interfaces to be implemented by records and/or POJOs. -
withImmutableInterfaces
Generate immutable interfaces. -
withSerializableInterfaces
Generate serializable interfaces. -
withDaos
Generate DAOs. -
withDaosIncludes
All the object identifiers for which to generate DAOs, by default, all of them.This is a Java regular expression. Use the pipe to separate several expressions. Watch out for case-sensitivity. Depending on your database, this might be important!
You can create case-insensitive regular expressions using this syntax:
(?i:expr)Whitespace is ignored and comments are possible unless overridden in
.invalid reference
#getRegexFlags() -
withDaosExcludes
All the object identifiers for which not to generate DAOs.This is a Java regular expression. Use the pipe to separate several expressions. Watch out for case-sensitivity. Depending on your database, this might be important!
You can create case-insensitive regular expressions using this syntax:
(?i:expr)Whitespace is ignored and comments are possible unless overridden in
.invalid reference
#getRegexFlags() -
withJooqVersionReference
Generate references to the most up to date minor release inConstantsto produce compilation errors if an outdated runtime library is being used. -
withJpaAnnotations
Annotate POJOs and Records with JPA annotations. -
withJpaVersion
Version of JPA specification is to be used to generate version-specific annotations. If it is omitted, the latest version is used by default. -
withValidationAnnotations
Annotate POJOs and Records with JSR-303 validation annotations -
withSpringAnnotations
Annotate DAOs with useful spring annotations such as @Repository or @Autowired. -
withSpringDao
Generate an AbstractSpringDAOImpl as a base class for other DAO classes, containing @Transactional annotations, etc. -
withKotlinSetterJvmNameAnnotationsOnIsPrefix
Workaround for Kotlin generatingsetX()setters instead ofsetIsX()in byte code for mutable properties calledisX. -
withKotlinNotNullPojoAttributes
Generate non-nullable types on POJO attributes, where column is not null. -
withKotlinNotNullRecordAttributes
Generate non-nullable types on Record attributes, where column is not null. -
withKotlinNotNullInterfaceAttributes
Generate non-nullable types on interface attributes, where column is not null. -
withKotlinDefaultedNullablePojoAttributes
Generate defaulted nullable POJO attributes. -
withKotlinDefaultedNullableRecordAttributes
Generate defaulted nullable Record attributes. -
withGlobalObjectNames
Turn on generation of all global object names. -
withGlobalObjectReferences
Turn off generation of all global object references. -
withGlobalCatalogReferences
Turn off generation of global catalog references. -
withGlobalSchemaReferences
Turn off generation of global schema references. -
withGlobalDomainReferences
Turn off generation of global domain references. -
withGlobalTriggerReferences
Turn off generation of global trigger references. -
withGlobalSynonymReferences
Turn off generation of global synonym references. -
withGlobalTableReferences
Turn off generation of global table references. -
withGlobalSequenceReferences
Turn off generation of global sequence references. -
withGlobalUDTReferences
Turn off generation of global UDT references. -
withGlobalRoutineReferences
Turn off generation of global routine references. -
withGlobalQueueReferences
Turn off generation of global queue references. -
withGlobalLinkReferences
Turn off generation of global database link references. -
withGlobalKeyReferences
Turn off generation of global key references. -
withGlobalIndexReferences
Turn off generation of global index references. -
withDefaultCatalog
Turn off generation of aDefaultCatalogobject, which is generated by default in the absence of catalogs. -
withDefaultSchema
Turn off generation of aDefaultSchemaobject, which is generated by default in the absence of schemas. -
withJavadoc
Turn off generation of Javadoc on all objects. -
withComments
Turn off generation of all SQL comments as Javadoc on all objects. -
withCommentsOnCatalogs
Turn off generation of all SQL comments as Javadoc on all catalogs. -
withCommentsOnSchemas
Turn off generation of all SQL comments as Javadoc on all schemas. -
withCommentsOnTables
Turn off generation of all SQL comments as Javadoc on all tables. -
withCommentsOnColumns
Turn off generation of all SQL comments as Javadoc on all columns. -
withCommentsOnEmbeddables
Turn off generation of all SQL comments as Javadoc on all embeddables. -
withCommentsOnUDTs
Turn off generation of all SQL comments as Javadoc on all UDTs. -
withCommentsOnAttributes
Turn off generation of all SQL comments as Javadoc on all attributes. -
withCommentsOnPackages
Turn off generation of all SQL comments as Javadoc on all packages. -
withCommentsOnRoutines
Turn off generation of all SQL comments as Javadoc on all routines. -
withCommentsOnParameters
Turn off generation of all SQL comments as Javadoc on all parameters. -
withCommentsOnSequences
Turn off generation of all SQL comments as Javadoc on all sequences. -
withCommentsOnDomains
Turn off generation of all SQL comments as Javadoc on all domains. -
withCommentsOnLinks
Turn off generation of all SQL comments as Javadoc on all links. -
withCommentsOnQueues
Turn off generation of all SQL comments as Javadoc on all queues. -
withCommentsOnKeys
Turn off generation of all SQL comments as Javadoc on all keys. -
withSources
Turn off generation of all source code on all object types. -
withSourcesOnViews
Turn off generation of all source code on all views. -
withFluentSetters
Generate fluent setters in records, POJOs, interfaces. -
withJavaBeansGettersAndSetters
Modify DefaultGeneratorStrategy behaviour to generate getters and setters in JavaBeans style in records, POJOs, interfaces.If this flag is set to false, then:
- Column name : X_INDEX
- Attribute name: xIndex
- Getter name : getXIndex()
- Setter name : setXIndex()
If this flag is set to true, then:
- Getter name : getxIndex()
- Setter name : setxIndex()
Custom GeneratorStrategy implementations are unaffected
-
withVarargSetters
Generate varargs setters for array types for convenience.This may lead to compilation warnings in current Java versions.
-
withGeneratedSerialVersionUID
The serial version UID to be generated in all files. -
withMaxMembersPerInitialiser
The maximum number of members per initialiser, to prevent reaching the 64kb byte code per method limit in generated code. -
withFullyQualifiedTypes
A regular expression matching all the types in generated code that should be fully qualified.This can be useful if you have a database object that generates a String class, and you want to avoid naming clashes with the java.lang package by specifying
java\.lang\..* -
withEmptyCatalogs
Whether empty catalogs (e.g. empty because ofconfigurations) should still be generated. -
withEmptySchemas
Whether empty schemas (e.g. empty because ofconfigurations) should still be generated. -
withJavaTimeTypes
A flag indicating whether Java 8's java.time types should be used by the source code generator, rather than JDBC's java.sql types.This flag is ignored in the commercial Java 6 distribution of jOOQ 3.9+
-
withSpatialTypes
A flag indicating whether the spatial type support should be enabled. -
withXmlTypes
A flag indicating whether the XML type support should be enabled. -
withJsonTypes
A flag indicating whether the JSON type support should be enabled. -
withIntervalTypes
A flag indicating whether the INTERVAL type support should be enabled. -
withDecfloatTypes
A flag indicating whether the DECFLOAT type support should be enabled. -
withNewline
The newline characters to be used in generated code. Whitespace characters can be used, e.g. \n, \r\n -
withIndentation
The indentation characters to be used in generated code. If unspecified, an idiomatic default indentation of the language will be used (4 spaces in Java, 2 spaces in Scala). Whitespace characters can be used, e.g. \t -
withPrintMarginForBlockComment
The print margin to apply to generated Javadoc and other block comments, for automatic line wrapping. The feature is turned off if the print margin is0. -
withTextBlocks
Whether to generate String in text block format. -
withWhereMethodOverrides
Whether to generate overrides forTable.where(org.jooq.Condition)and related overloads. -
withRenameMethodOverrides
Whether to generate overrides (see https://github.com/jOOQ/jOOQ/issues/13937) forand related overloads.invalid reference
org.jooq.Table#rename(org.jooq.Name) -
withAsMethodOverrides
Whether to generate overrides forTable.as(org.jooq.Name)and related overloads. -
withHiddenColumnsInRecords
Whether hidden columns should be generated in records.This feature is available in the commercial distribution only.
-
withHiddenColumnsInPojos
Whether hidden columns should be generated in POJOs.This feature is available in the commercial distribution only.
-
withHiddenColumnsInInterfaces
Whether hidden columns should be generated in interfaces.This feature is available in the commercial distribution only.
-
appendTo
- Specified by:
appendToin interfaceXMLAppendable
-
toString
-
equals
-
hashCode
public int hashCode()
-