public interface Generator
| Modifier and Type | Method and Description |
|---|---|
boolean |
fluentSetters()
Deprecated.
- Use
generateFluentSetters() instead. |
String |
fullyQualifiedTypes()
Deprecated.
- Use
generateFullyQualifiedTypes() instead. |
void |
generate(Database database)
Do the code generation
|
boolean |
generateComments()
Whether any SQL comments should be generated as Javadoc.
|
boolean |
generateCommentsOnAttributes()
Whether SQL comments on attributes should be generated as Javadoc.
|
boolean |
generateCommentsOnCatalogs()
Whether SQL comments on catalogs should be generated as Javadoc.
|
boolean |
generateCommentsOnColumns()
Whether SQL comments on columns should be generated as Javadoc.
|
boolean |
generateCommentsOnKeys()
Whether SQL comments on keys should be generated as Javadoc.
|
boolean |
generateCommentsOnLinks()
Whether SQL comments on links should be generated as Javadoc.
|
boolean |
generateCommentsOnPackages()
Whether SQL comments on packages should be generated as Javadoc.
|
boolean |
generateCommentsOnParameters()
Whether SQL comments on parameters should be generated as Javadoc.
|
boolean |
generateCommentsOnQueues()
Whether SQL comments on queues should be generated as Javadoc.
|
boolean |
generateCommentsOnRoutines()
Whether SQL comments on routines should be generated as Javadoc.
|
boolean |
generateCommentsOnSchemas()
Whether SQL comments on schemas should be generated as Javadoc.
|
boolean |
generateCommentsOnSequences()
Whether SQL comments on sequences should be generated as Javadoc.
|
boolean |
generateCommentsOnTables()
Whether SQL comments on tables should be generated as Javadoc.
|
boolean |
generateCommentsOnUDTs()
Whether SQL comments on UDTs should be generated as Javadoc.
|
boolean |
generateDaos()
Whether DAO's should be generated in addition to pojos
|
boolean |
generateDeprecated()
Whether deprecated code should be generated
|
boolean |
generateDeprecationOnUnknownTypes()
Whether deprecation should be generated on unknown types.
|
boolean |
generateEmptyCatalogs()
Whether empty catalogs should still be generated.
|
boolean |
generateEmptySchemas()
Whether empty schemas should still be generated.
|
boolean |
generateFluentSetters()
Whether fluent setters should be generated
|
String |
generateFullyQualifiedTypes()
A regular expression matching all the types in generated code that should
be fully qualified.
|
boolean |
generateGeneratedAnnotation()
Whether the
Generated annotation should be generated |
boolean |
generateGlobalCatalogReferences()
Whether global catalog references should be generated
|
boolean |
generateGlobalKeyReferences()
Whether global key references should be generated
|
boolean |
generateGlobalLinkReferences()
Whether global link references should be generated
|
boolean |
generateGlobalObjectReferences()
Whether global object references should be generated
|
boolean |
generateGlobalQueueReferences()
Whether global queue references should be generated
|
boolean |
generateGlobalRoutineReferences()
Whether global routine references should be generated
|
boolean |
generateGlobalSchemaReferences()
Whether global schema references should be generated
|
boolean |
generateGlobalSequenceReferences()
Whether global sequence references should be generated
|
boolean |
generateGlobalTableReferences()
Whether global table references should be generated
|
boolean |
generateGlobalUDTReferences()
Whether global UDT references should be generated
|
boolean |
generateImmutableInterfaces()
Whether immutable interfaces should be generated in addition to records
|
boolean |
generateImmutablePojos()
Whether immutable POJO's should be generated in addition to records
|
boolean |
generateImplicitJoinPathsToOne()
Whether implicit join path constructors on generated tables for outgoing
foreign key relationships (to-one relationships) should be generated.
|
boolean |
generateIndexes()
Whether indexes should be generated.
|
boolean |
generateInstanceFields()
Whether instance fields should be generated (as opposed to static fields)
|
boolean |
generateInterfaces()
Whether interfaces should be generated to be implemented by records and
POJO's
|
boolean |
generateJavaBeansGettersAndSetters()
Whether getters and setters should be generated JavaBeans style (or jOOQ style).
|
boolean |
generateJavadoc()
Whether any Javadoc should be generated.
|
boolean |
generateJavaTimeTypes()
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.
|
boolean |
generateJPAAnnotations()
Whether POJO's and records should be annotated with JPA annotations
|
String |
generateJPAVersion()
The minimum JPA version that is supported by generated code (latest version if empty).
|
boolean |
generateKeys()
Whether key related code should be generated
|
boolean |
generateLinks()
Whether link related code should be generated
|
boolean |
generatePojos()
Whether POJO's should be generated in addition to records
|
boolean |
generatePojosEqualsAndHashCode()
Whether
equals() and hashCode() methods should
be generated on POJOs |
boolean |
generatePojosToString()
Whether a
toString() method should be generated on POJOs |
boolean |
generatePrimaryKeyTypes()
Whether wrapper types for primary keys should be generated.
|
boolean |
generateQueues()
Whether queue related code should be generated
|
boolean |
generateRecords()
Whether TableRecords should be generated in addition to tables
|
boolean |
generateRecordsImplementingRecordN()
Whether TableRecords should be generated in addition to tables, which implement Record[N] types
|
boolean |
generateRelations()
Whether foreign key relations should be resolved
|
boolean |
generateRoutines()
Whether Routines should be generated.
|
boolean |
generateSequences()
Whether Sequences should be generated.
|
boolean |
generateSerializableInterfaces()
Whether generated interfaces should extend
Serializable. |
boolean |
generateSerializablePojos()
Whether generated POJO's should be
Serializable. |
boolean |
generateSpringAnnotations()
Whether DAOs should be annotated with useful spring annotations such as
@Repository or @Autowired |
boolean |
generateTables()
Whether Tables should be generated
|
boolean |
generateTableValuedFunctions()
Whether table-valued functions should be generated as tables.
|
boolean |
generateUDTs()
Whether UDTs should be generated.
|
boolean |
generateValidationAnnotations()
Whether POJO's and records should be annotated with JSR-303 validation
annotations
|
boolean |
generateVarargsSetters()
Whether varargs setters should be generated for array types.
|
GeneratorStrategy |
getStrategy()
Get this generator's underlying naming strategy
|
boolean |
getTargetClean()
Whether the target package should be cleaned to contain only generated code after a generation run.
|
String |
getTargetDirectory()
The target directory
|
String |
getTargetEncoding()
The target encoding
|
String |
getTargetPackage() |
void |
setFluentSetters(boolean fluentSetters)
Deprecated.
- Use
setGenerateFluentSetters(boolean) instead. |
void |
setFullyQualifiedTypes(String fullyQualifiedTypes)
Deprecated.
- Use
setGenerateFullyQualifiedTypes(String)
instead. |
void |
setGenerateComments(boolean comments)
Whether any SQL comments should be generated as Javadoc.
|
void |
setGenerateCommentsOnAttributes(boolean commentsOnAttributes)
Whether SQL comments on attributes should be generated as Javadoc.
|
void |
setGenerateCommentsOnCatalogs(boolean commentsOnCatalogs)
Whether SQL comments on catalogs should be generated as Javadoc.
|
void |
setGenerateCommentsOnColumns(boolean commentsOnColumns)
Whether SQL comments on columns should be generated as Javadoc.
|
void |
setGenerateCommentsOnKeys(boolean commentsOnKeys)
Whether SQL comments on keys should be generated as Javadoc.
|
void |
setGenerateCommentsOnLinks(boolean commentsOnLinks)
Whether SQL comments on links should be generated as Javadoc.
|
void |
setGenerateCommentsOnPackages(boolean commentsOnPackages)
Whether SQL comments on packages should be generated as Javadoc.
|
void |
setGenerateCommentsOnParameters(boolean commentsOnParameters)
Whether SQL comments on parameters should be generated as Javadoc.
|
void |
setGenerateCommentsOnQueues(boolean commentsOnQueues)
Whether SQL comments on queues should be generated as Javadoc.
|
void |
setGenerateCommentsOnRoutines(boolean commentsOnRoutines)
Whether SQL comments on routines should be generated as Javadoc.
|
void |
setGenerateCommentsOnSchemas(boolean commentsOnSchemas)
Whether SQL comments on schemas should be generated as Javadoc.
|
void |
setGenerateCommentsOnSequences(boolean commentsOnSequences)
Whether SQL comments on sequences should be generated as Javadoc.
|
void |
setGenerateCommentsOnTables(boolean commentsOnTables)
Whether SQL comments on tables should be generated as Javadoc.
|
void |
setGenerateCommentsOnUDTs(boolean commentsOnUDTs)
Whether SQL comments on UDTs should be generated as Javadoc.
|
void |
setGenerateDaos(boolean generateDaos)
Whether DAO's should be generated in addition to pojos
|
void |
setGenerateDeprecated(boolean generateDeprecated)
Whether deprecated code should be generated
|
void |
setGenerateDeprecationOnUnknownTypes(boolean generateDeprecationOnUnknownTypes)
Whether deprecation should be generated on unknown types.
|
void |
setGenerateEmptyCatalogs(boolean generateEmptyCatalogs)
Whether empty catalogs should still be generated.
|
void |
setGenerateEmptySchemas(boolean generateEmptySchemas)
Whether empty schemas should still be generated.
|
void |
setGenerateFluentSetters(boolean fluentSetters)
Whether fluent setters should be generated
|
void |
setGenerateFullyQualifiedTypes(String generateFullyQualifiedTypes)
A regular expression matching all the types in generated code that should
be fully qualified.
|
void |
setGenerateGeneratedAnnotation(boolean generateGeneratedAnnotation)
Whether the
Generated annotation should be generated |
void |
setGenerateGlobalCatalogReferences(boolean globalCatalogReferences)
Whether global catalog references should be generated
|
void |
setGenerateGlobalKeyReferences(boolean globalKeyReferences)
Whether global key references should be generated
|
void |
setGenerateGlobalLinkReferences(boolean globalLinkReferences)
Whether global link references should be generated
|
void |
setGenerateGlobalObjectReferences(boolean generateGlobalObjectReferences)
Whether global object references should be generated
|
void |
setGenerateGlobalQueueReferences(boolean globalQueueReferences)
Whether global queue references should be generated
|
void |
setGenerateGlobalRoutineReferences(boolean globalRoutineReferences)
Whether global routine references should be generated
|
void |
setGenerateGlobalSchemaReferences(boolean globalSchemaReferences)
Whether global schema references should be generated
|
void |
setGenerateGlobalSequenceReferences(boolean globalSequenceReferences)
Whether global sequence references should be generated
|
void |
setGenerateGlobalTableReferences(boolean globalTableReferences)
Whether global table references should be generated
|
void |
setGenerateGlobalUDTReferences(boolean globalUDTReferences)
Whether global UDT references should be generated
|
void |
setGenerateImmutableInterfaces(boolean generateImmutableInterfaces)
Whether immutable interfaces should be generated in addition to records
|
void |
setGenerateImmutablePojos(boolean generateImmutablePojos)
Whether immutable POJO's should be generated in addition to records
|
void |
setGenerateImplicitJoinPathsToOne(boolean generateImplicitJoinPathsToOne)
Whether implicit join path constructors on generated tables for outgoing
foreign key relationships (to-one relationships) should be generated.
|
void |
setGenerateIndexes(boolean generateIndexes)
Whether indexes should be generated.
|
void |
setGenerateInstanceFields(boolean generateInstanceFields)
Whether instance fields should be generated (as opposed to static fields)
|
void |
setGenerateInterfaces(boolean generateInterfaces)
Whether interfaces should be generated to be implemented by records and
POJO's
|
void |
setGenerateJavaBeansGettersAndSetters(boolean javaBeansGettersAndSetters)
Whether getters and setters should be generated JavaBeans style (or jOOQ style).
|
void |
setGenerateJavadoc(boolean javadoc)
Whether any Javadoc should be generated.
|
void |
setGenerateJavaTimeTypes(boolean generateJavaTimeTypes)
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.
|
void |
setGenerateJPAAnnotations(boolean generateJPAAnnotations)
Whether POJO's and records should be annotated with JPA annotations
|
void |
setGenerateJPAVersion(String generateJPAVersion)
The minimum JPA version that is supported by generated code (latest version if empty).
|
void |
setGenerateKeys(boolean keys)
Whether key related code should be generated
|
void |
setGenerateLinks(boolean links)
Whether link related code should be generated
|
void |
setGeneratePojos(boolean generatePojos)
Whether POJO's should be generated in addition to records
|
void |
setGeneratePojosEqualsAndHashCode(boolean generatePojosEqualsAndHashCode)
Whether
equals() and hashCode() methods should
be generated on POJOs |
void |
setGeneratePojosToString(boolean generatePojosToString)
Whether a
toString() method should be generated on POJOs |
void |
setGeneratePrimaryKeyTypes(boolean generatePrimaryKeyTypes)
Whether wrapper types for primary keys should be generated.
|
void |
setGenerateQueues(boolean queues)
Whether queue related code should be generated
|
void |
setGenerateRecords(boolean generateRecords)
Whether TableRecords should be generated in addition to tables
|
void |
setGenerateRecordsImplementingRecordN(boolean generateRecordsImplementingRecordN)
Whether TableRecords should be generated in addition to tables, which implement Record[N] types
|
void |
setGenerateRelations(boolean generateRelations)
Whether foreign key relations should be resolved
|
void |
setGenerateRoutines(boolean generateRoutines)
Whether Routines should be generated.
|
void |
setGenerateSequences(boolean generateSequences)
Whether Sequences should be generated.
|
void |
setGenerateSerializableInterfaces(boolean generateSerializableInterfaces)
Whether generated interfaces should extend
Serializable. |
void |
setGenerateSerializablePojos(boolean generateSerializablePojos)
Whether generated POJO's should be
Serializable. |
void |
setGenerateSpringAnnotations(boolean generateSpringAnnotations)
Whether DAOs should be annotated with useful spring annotations such as
@Repository or @Autowired |
void |
setGenerateTables(boolean generateTables)
Whether Tables should be generated
|
void |
setGenerateTableValuedFunctions(boolean generateTableValuedFunctions)
Whether table-valued functions should be generated as tables.
|
void |
setGenerateUDTs(boolean generateUDTs)
Whether UDTs should be generated.
|
void |
setGenerateValidationAnnotations(boolean generateValidationAnnotations)
Whether POJO's and records should be annotated with JSR-303 validation
annotations
|
void |
setGenerateVarargsSetters(boolean varargsSetters)
Whether varargs setters should be generated for array types.
|
void |
setStrategy(GeneratorStrategy strategy)
Set a naming strategy to this generator
|
void |
setTargetClean(boolean clean)
Whether the target package should be cleaned to contain only generated code after a generation run.
|
void |
setTargetDirectory(String directory)
Initialise the target directory
|
void |
setTargetEncoding(String encoding)
Initialise the target encoding
|
void |
setTargetPackage(String packageName)
Initialise the target package name
|
void |
setUseCatalogVersionProvider(boolean useCatalogVersionProvider) |
void |
setUseSchemaVersionProvider(boolean useSchemaVersionProvider) |
boolean |
useCatalogVersionProvider() |
boolean |
useSchemaVersionProvider() |
void generate(Database database)
void setStrategy(GeneratorStrategy strategy)
GeneratorStrategy getStrategy()
boolean generateDeprecated()
void setGenerateDeprecated(boolean generateDeprecated)
boolean generateDeprecationOnUnknownTypes()
void setGenerateDeprecationOnUnknownTypes(boolean generateDeprecationOnUnknownTypes)
boolean generateIndexes()
void setGenerateIndexes(boolean generateIndexes)
boolean generateRelations()
void setGenerateRelations(boolean generateRelations)
boolean generateImplicitJoinPathsToOne()
void setGenerateImplicitJoinPathsToOne(boolean generateImplicitJoinPathsToOne)
boolean generateTableValuedFunctions()
void setGenerateTableValuedFunctions(boolean generateTableValuedFunctions)
boolean generateInstanceFields()
void setGenerateInstanceFields(boolean generateInstanceFields)
boolean generateGeneratedAnnotation()
Generated annotation should be generatedvoid setGenerateGeneratedAnnotation(boolean generateGeneratedAnnotation)
Generated annotation should be generatedboolean useSchemaVersionProvider()
void setUseSchemaVersionProvider(boolean useSchemaVersionProvider)
boolean useCatalogVersionProvider()
void setUseCatalogVersionProvider(boolean useCatalogVersionProvider)
boolean generateRoutines()
void setGenerateRoutines(boolean generateRoutines)
boolean generateSequences()
void setGenerateSequences(boolean generateSequences)
boolean generateUDTs()
void setGenerateUDTs(boolean generateUDTs)
boolean generateTables()
void setGenerateTables(boolean generateTables)
boolean generateRecords()
void setGenerateRecords(boolean generateRecords)
boolean generateRecordsImplementingRecordN()
void setGenerateRecordsImplementingRecordN(boolean generateRecordsImplementingRecordN)
boolean generatePojos()
void setGeneratePojos(boolean generatePojos)
boolean generateImmutablePojos()
void setGenerateImmutablePojos(boolean generateImmutablePojos)
boolean generateSerializablePojos()
Serializable.void setGenerateSerializablePojos(boolean generateSerializablePojos)
Serializable.boolean generateInterfaces()
void setGenerateInterfaces(boolean generateInterfaces)
boolean generateImmutableInterfaces()
void setGenerateImmutableInterfaces(boolean generateImmutableInterfaces)
boolean generateSerializableInterfaces()
Serializable.void setGenerateSerializableInterfaces(boolean generateSerializableInterfaces)
Serializable.boolean generateDaos()
void setGenerateDaos(boolean generateDaos)
boolean generateJPAAnnotations()
void setGenerateJPAAnnotations(boolean generateJPAAnnotations)
String generateJPAVersion()
void setGenerateJPAVersion(String generateJPAVersion)
boolean generateValidationAnnotations()
void setGenerateValidationAnnotations(boolean generateValidationAnnotations)
boolean generateSpringAnnotations()
@Repository or @Autowiredvoid setGenerateSpringAnnotations(boolean generateSpringAnnotations)
@Repository or @Autowiredboolean generateGlobalObjectReferences()
void setGenerateGlobalObjectReferences(boolean generateGlobalObjectReferences)
boolean generateGlobalCatalogReferences()
void setGenerateGlobalCatalogReferences(boolean globalCatalogReferences)
boolean generateGlobalSchemaReferences()
void setGenerateGlobalSchemaReferences(boolean globalSchemaReferences)
boolean generateGlobalRoutineReferences()
void setGenerateGlobalRoutineReferences(boolean globalRoutineReferences)
boolean generateGlobalSequenceReferences()
void setGenerateGlobalSequenceReferences(boolean globalSequenceReferences)
boolean generateGlobalTableReferences()
void setGenerateGlobalTableReferences(boolean globalTableReferences)
boolean generateGlobalUDTReferences()
void setGenerateGlobalUDTReferences(boolean globalUDTReferences)
boolean generateGlobalQueueReferences()
void setGenerateGlobalQueueReferences(boolean globalQueueReferences)
boolean generateGlobalLinkReferences()
void setGenerateGlobalLinkReferences(boolean globalLinkReferences)
boolean generateGlobalKeyReferences()
void setGenerateGlobalKeyReferences(boolean globalKeyReferences)
boolean generateJavadoc()
void setGenerateJavadoc(boolean javadoc)
boolean generateComments()
void setGenerateComments(boolean comments)
boolean generateCommentsOnAttributes()
void setGenerateCommentsOnAttributes(boolean commentsOnAttributes)
boolean generateCommentsOnCatalogs()
void setGenerateCommentsOnCatalogs(boolean commentsOnCatalogs)
boolean generateCommentsOnColumns()
void setGenerateCommentsOnColumns(boolean commentsOnColumns)
boolean generateCommentsOnKeys()
void setGenerateCommentsOnKeys(boolean commentsOnKeys)
boolean generateCommentsOnLinks()
void setGenerateCommentsOnLinks(boolean commentsOnLinks)
boolean generateCommentsOnPackages()
void setGenerateCommentsOnPackages(boolean commentsOnPackages)
boolean generateCommentsOnParameters()
void setGenerateCommentsOnParameters(boolean commentsOnParameters)
boolean generateCommentsOnQueues()
void setGenerateCommentsOnQueues(boolean commentsOnQueues)
boolean generateCommentsOnRoutines()
void setGenerateCommentsOnRoutines(boolean commentsOnRoutines)
boolean generateCommentsOnSchemas()
void setGenerateCommentsOnSchemas(boolean commentsOnSchemas)
boolean generateCommentsOnSequences()
void setGenerateCommentsOnSequences(boolean commentsOnSequences)
boolean generateCommentsOnTables()
void setGenerateCommentsOnTables(boolean commentsOnTables)
boolean generateCommentsOnUDTs()
void setGenerateCommentsOnUDTs(boolean commentsOnUDTs)
boolean generateQueues()
void setGenerateQueues(boolean queues)
boolean generateLinks()
void setGenerateLinks(boolean links)
boolean generateKeys()
void setGenerateKeys(boolean keys)
@Deprecated boolean fluentSetters()
generateFluentSetters() instead.@Deprecated void setFluentSetters(boolean fluentSetters)
setGenerateFluentSetters(boolean) instead.boolean generateFluentSetters()
void setGenerateFluentSetters(boolean fluentSetters)
boolean generateJavaBeansGettersAndSetters()
void setGenerateJavaBeansGettersAndSetters(boolean javaBeansGettersAndSetters)
boolean generateVarargsSetters()
void setGenerateVarargsSetters(boolean varargsSetters)
boolean generatePojosEqualsAndHashCode()
equals() and hashCode() methods should
be generated on POJOsvoid setGeneratePojosEqualsAndHashCode(boolean generatePojosEqualsAndHashCode)
equals() and hashCode() methods should
be generated on POJOsboolean generatePojosToString()
toString() method should be generated on POJOsvoid setGeneratePojosToString(boolean generatePojosToString)
toString() method should be generated on POJOs@Deprecated String fullyQualifiedTypes()
generateFullyQualifiedTypes() instead.@Deprecated void setFullyQualifiedTypes(String fullyQualifiedTypes)
setGenerateFullyQualifiedTypes(String)
instead.String generateFullyQualifiedTypes()
void setGenerateFullyQualifiedTypes(String generateFullyQualifiedTypes)
boolean generateJavaTimeTypes()
This flag is ignored in the commercial Java 6 distribution of jOOQ 3.9+
void setGenerateJavaTimeTypes(boolean generateJavaTimeTypes)
This flag is ignored in the commercial Java 6 distribution of jOOQ 3.9+
boolean generateEmptyCatalogs()
void setGenerateEmptyCatalogs(boolean generateEmptyCatalogs)
boolean generateEmptySchemas()
void setGenerateEmptySchemas(boolean generateEmptySchemas)
boolean generatePrimaryKeyTypes()
void setGeneratePrimaryKeyTypes(boolean generatePrimaryKeyTypes)
String getTargetDirectory()
void setTargetDirectory(String directory)
String getTargetEncoding()
void setTargetEncoding(String encoding)
String getTargetPackage()
void setTargetPackage(String packageName)
boolean getTargetClean()
void setTargetClean(boolean clean)
Copyright © 2018. All rights reserved.