-
- All Known Implementing Classes:
DefaultGenerator
,JavaGenerator
,KotlinGenerator
,ScalaGenerator
,XMLGenerator
public interface Generator
The Generator provides a basic interface for java code generation- Author:
- Lukas Eder
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description boolean
fluentSetters()
Deprecated.- UsegenerateFluentSetters()
instead.String
fullyQualifiedTypes()
Deprecated.- UsegenerateFullyQualifiedTypes()
instead.void
generate(Database database)
Do the code generationboolean
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
generateCommentsOnEmbeddables()
Whether SQL comments on embeddables 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
generateConstructorPropertiesAnnotation()
Whether theConstructorProperties
annotation should be generated.boolean
generateConstructorPropertiesAnnotationOnPojos()
Whether theConstructorProperties
annotation should be generated on POJOs.boolean
generateConstructorPropertiesAnnotationOnRecords()
Whether theConstructorProperties
annotation should be generated on records.boolean
generateDaos()
Whether DAO's should be generated in addition to pojosboolean
generateDeprecated()
Whether deprecated code should be generatedboolean
generateDeprecationOnUnknownTypes()
Whether deprecation should be generated on unknown types.String
generatedNonnullAnnotationType()
Which type of Nonnull annotation should be generated.String
generatedNullableAnnotationType()
Which type of Nullable annotation should be generated.GeneratedSerialVersionUID
generatedSerialVersionUID()
The type ofserialVersionUID
that should be generated.boolean
generateEmbeddables()
Whether embeddable types should be generatedboolean
generateEmptyCatalogs()
Whether empty catalogs should still be generated.boolean
generateEmptySchemas()
Whether empty schemas should still be generated.boolean
generateEnumsAsScalaSealedTraits()
Deprecated.- [#10998] - 3.15.0 - This is maintained for backwards compatibility only.boolean
generateFluentSetters()
Whether fluent setters should be generatedString
generateFullyQualifiedTypes()
A regular expression matching all the types in generated code that should be fully qualified.boolean
generateGeneratedAnnotation()
Whether thejavax.annotation.Generated
orGenerated
annotation should be generated.boolean
generateGeneratedAnnotationDate()
GeneratedAnnotationType
generateGeneratedAnnotationType()
Whether thejavax.annotation.Generated
orGenerated
annotation should be generated.boolean
generateGlobalCatalogReferences()
Whether global catalog references should be generatedboolean
generateGlobalDomainReferences()
Whether global domain references should be generatedboolean
generateGlobalIndexReferences()
Whether global index references should be generatedboolean
generateGlobalKeyReferences()
Whether global key references should be generatedboolean
generateGlobalLinkReferences()
Whether global link references should be generatedboolean
generateGlobalObjectReferences()
Whether global object references should be generatedboolean
generateGlobalQueueReferences()
Whether global queue references should be generatedboolean
generateGlobalRoutineReferences()
Whether global routine references should be generatedboolean
generateGlobalSchemaReferences()
Whether global schema references should be generatedboolean
generateGlobalSequenceReferences()
Whether global sequence references should be generatedboolean
generateGlobalTableReferences()
Whether global table references should be generatedboolean
generateGlobalUDTReferences()
Whether global UDT references should be generatedboolean
generateImmutableInterfaces()
Whether immutable interfaces should be generated in addition to recordsboolean
generateImmutablePojos()
Whether immutable POJO's should be generated in addition to recordsboolean
generateImplicitJoinPathsToOne()
Whether implicit join path constructors on generated tables for outgoing foreign key relationships (to-one relationships) should be generated.String
generateIndentation()
The indentation character(s) to be used in generated code.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'sboolean
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 annotationsString
generateJPAVersion()
The minimum JPA version that is supported by generated code (latest version if empty).boolean
generateKeys()
Whether key related code should be generatedboolean
generateKotlinSetterJvmNameAnnotationsOnIsPrefix()
Whether kotlin mutable properties should be annotated withset:JvmName
as a workaround for problems occurring when kotlin producessetX()
instead ofsetIsX()
setters for anisX
property.boolean
generateLinks()
Whether link related code should be generatedString
generateNewline()
The newline character(s) to be used in generated code.boolean
generateNonnullAnnotation()
Whether Nonnull annotations should be generated.boolean
generateNullableAnnotation()
Whether Nullable annotations should be generated.boolean
generatePojos()
Whether POJO's should be generated in addition to recordsboolean
generatePojosAsJavaRecordClasses()
Whether POJOs should be generated as Java records by theJavaGenerator
.boolean
generatePojosAsKotlinDataClasses()
Whether POJOs should be generated as Kotlin data classes by theKotlinGenerator
.boolean
generatePojosAsScalaCaseClasses()
Whether POJOs should be generated as Scala case classes by theScalaGenerator
.boolean
generatePojosEqualsAndHashCode()
Whetherequals()
andhashCode()
methods should be generated on POJOsboolean
generatePojosToString()
Whether atoString()
method should be generated on POJOsint
generatePrintMarginForBlockComment()
The print margin for Javadoc and other block comments to be used in generated code.boolean
generateQueues()
Whether queue related code should be generatedboolean
generateRecords()
Whether TableRecords should be generated in addition to tablesboolean
generateRecordsImplementingRecordN()
Whether TableRecords should be generated in addition to tables, which implement Record[N] typesboolean
generateRelations()
Whether foreign key relations should be resolvedboolean
generateRoutines()
Whether Routines should be generated.boolean
generateSequenceFlags()
Whether sequence flags should be generated.boolean
generateSequences()
Whether Sequences should be generated.boolean
generateSerializableInterfaces()
Whether generated interfaces should extendSerializable
.boolean
generateSerializablePojos()
Whether generated POJO's should beSerializable
.boolean
generateSources()
Whether source code should be generated on any object type.boolean
generateSourcesOnViews()
Whether source code should be generated on views.boolean
generateSpringAnnotations()
Whether DAOs should be annotated with useful spring annotations such as@Repository
or@Autowired
boolean
generateTables()
Whether Tables should be generatedboolean
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 annotationsboolean
generateVarargsSetters()
Whether varargs setters should be generated for array types.VisibilityModifier
generateVisibilityModifier()
TheVisibilityModifier
that should be used in generated code.GeneratorStrategy
getStrategy()
Get this generator's underlying naming strategyboolean
getTargetClean()
Whether the target package should be cleaned to contain only generated code after a generation run.String
getTargetDirectory()
The target directoryString
getTargetEncoding()
The target encodingLocale
getTargetLocale()
The target locale.String
getTargetPackage()
int
maxMembersPerInitialiser()
The maximum number of members per initialiser, to prevent reaching the 64kb byte code per method limit in generated code.void
setFluentSetters(boolean fluentSetters)
Deprecated.- UsesetGenerateFluentSetters(boolean)
instead.void
setFullyQualifiedTypes(String fullyQualifiedTypes)
Deprecated.- UsesetGenerateFullyQualifiedTypes(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
setGenerateCommentsOnEmbeddables(boolean commentsOnEmbeddables)
Whether SQL comments on embeddables 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
setGenerateConstructorPropertiesAnnotation(boolean generateConstructorPropertiesAnnotation)
Whether theConstructorProperties
annotation should be generated.void
setGenerateConstructorPropertiesAnnotationOnPojos(boolean generateConstructorPropertiesAnnotationOnPojos)
Whether theConstructorProperties
annotation should be generated on POJOs.void
setGenerateConstructorPropertiesAnnotationOnRecords(boolean generateConstructorPropertiesAnnotationOnRecords)
Whether theConstructorProperties
annotation should be generated on records.void
setGenerateDaos(boolean generateDaos)
Whether DAO's should be generated in addition to pojosvoid
setGenerateDeprecated(boolean generateDeprecated)
Whether deprecated code should be generatedvoid
setGenerateDeprecationOnUnknownTypes(boolean generateDeprecationOnUnknownTypes)
Whether deprecation should be generated on unknown types.void
setGeneratedNonnullAnnotationType(String generatedNonnullAnnotationType)
Which type of Nonnull annotation should be generated.void
setGeneratedNullableAnnotationType(String generatedNullableAnnotationType)
Which type of Nullable annotation should be generated.void
setGenerateEmbeddables(boolean generateEmbeddables)
Whether embeddable types should be generatedvoid
setGenerateEmptyCatalogs(boolean generateEmptyCatalogs)
Whether empty catalogs should still be generated.void
setGenerateEmptySchemas(boolean generateEmptySchemas)
Whether empty schemas should still be generated.void
setGenerateEnumsAsScalaSealedTraits(boolean generateEnumsAsScalaSealedTraits)
Deprecated.- [#10998] - 3.15.0 - This is maintained for backwards compatibility only.void
setGenerateFluentSetters(boolean fluentSetters)
Whether fluent setters should be generatedvoid
setGenerateFullyQualifiedTypes(String generateFullyQualifiedTypes)
A regular expression matching all the types in generated code that should be fully qualified.void
setGenerateGeneratedAnnotation(boolean generateGeneratedAnnotation)
Whether thejavax.annotation.Generated
orGenerated
annotation should be generated.void
setGenerateGeneratedAnnotationDate(boolean generateGeneratedAnnotationDate)
void
setGenerateGeneratedAnnotationType(GeneratedAnnotationType generateGeneratedAnnotationType)
Whether thejavax.annotation.Generated
orGenerated
annotation should be generated.void
setGenerateGeneratedSerialVersionUID(GeneratedSerialVersionUID generatedSerialVersionUID)
The type ofserialVersionUID
that should be generated.void
setGenerateGlobalCatalogReferences(boolean globalCatalogReferences)
Whether global catalog references should be generatedvoid
setGenerateGlobalDomainReferences(boolean globalDomainReferences)
Whether global domain references should be generatedvoid
setGenerateGlobalIndexReferences(boolean globalIndexReferences)
Whether global index references should be generatedvoid
setGenerateGlobalKeyReferences(boolean globalKeyReferences)
Whether global key references should be generatedvoid
setGenerateGlobalLinkReferences(boolean globalLinkReferences)
Whether global link references should be generatedvoid
setGenerateGlobalObjectReferences(boolean generateGlobalObjectReferences)
Whether global object references should be generatedvoid
setGenerateGlobalQueueReferences(boolean globalQueueReferences)
Whether global queue references should be generatedvoid
setGenerateGlobalRoutineReferences(boolean globalRoutineReferences)
Whether global routine references should be generatedvoid
setGenerateGlobalSchemaReferences(boolean globalSchemaReferences)
Whether global schema references should be generatedvoid
setGenerateGlobalSequenceReferences(boolean globalSequenceReferences)
Whether global sequence references should be generatedvoid
setGenerateGlobalTableReferences(boolean globalTableReferences)
Whether global table references should be generatedvoid
setGenerateGlobalUDTReferences(boolean globalUDTReferences)
Whether global UDT references should be generatedvoid
setGenerateImmutableInterfaces(boolean generateImmutableInterfaces)
Whether immutable interfaces should be generated in addition to recordsvoid
setGenerateImmutablePojos(boolean generateImmutablePojos)
Whether immutable POJO's should be generated in addition to recordsvoid
setGenerateImplicitJoinPathsToOne(boolean generateImplicitJoinPathsToOne)
Whether implicit join path constructors on generated tables for outgoing foreign key relationships (to-one relationships) should be generated.void
setGenerateIndentation(String indentation)
The indentation character(s) to be used in generated code.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'svoid
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 annotationsvoid
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 generatedvoid
setGenerateKotlinSetterJvmNameAnnotationsOnIsPrefix(boolean generateKotlinSetterJvmNameAnnotationsOnIsPrefix)
Whether kotlin mutable properties should be annotated withset:JvmName
as a workaround for problems occurring when kotlin producessetX()
instead ofsetIsX()
setters for anisX
property.void
setGenerateLinks(boolean links)
Whether link related code should be generatedvoid
setGenerateNewline(String newline)
The newline character(s) to be used in generated code.void
setGenerateNonnullAnnotation(boolean generateNonnullAnnotation)
Whether Nonnull annotations should be generated.void
setGenerateNullableAnnotation(boolean generateNullableAnnotation)
Whether Nullable annotations should be generated.void
setGeneratePojos(boolean generatePojos)
Whether POJO's should be generated in addition to recordsvoid
setGeneratePojosAsJavaRecordClasses(boolean pojosAsJavaRecordClasses)
Whether POJOs should be generated as Java records by theJavaGenerator
.void
setGeneratePojosAsKotlinDataClasses(boolean pojosAsKotlinDataClasses)
Whether POJOs should be generated as Kotlin data classes by theKotlinGenerator
.void
setGeneratePojosAsScalaCaseClasses(boolean pojosAsScalaCaseClasses)
Whether POJOs should be generated as Scala case classes by theScalaGenerator
.void
setGeneratePojosEqualsAndHashCode(boolean generatePojosEqualsAndHashCode)
Whetherequals()
andhashCode()
methods should be generated on POJOsvoid
setGeneratePojosToString(boolean generatePojosToString)
Whether atoString()
method should be generated on POJOsvoid
setGeneratePrintMarginForBlockComment(int printMarginForBlockComment)
The print margin for Javadoc and other block comments to be used in generated code.void
setGenerateQueues(boolean queues)
Whether queue related code should be generatedvoid
setGenerateRecords(boolean generateRecords)
Whether TableRecords should be generated in addition to tablesvoid
setGenerateRecordsImplementingRecordN(boolean generateRecordsImplementingRecordN)
Whether TableRecords should be generated in addition to tables, which implement Record[N] typesvoid
setGenerateRelations(boolean generateRelations)
Whether foreign key relations should be resolvedvoid
setGenerateRoutines(boolean generateRoutines)
Whether Routines should be generated.void
setGenerateSequenceFlags(boolean generateSequenceFlags)
Whether sequence flags should be generated.void
setGenerateSequences(boolean generateSequences)
Whether Sequences should be generated.void
setGenerateSerializableInterfaces(boolean generateSerializableInterfaces)
Whether generated interfaces should extendSerializable
.void
setGenerateSerializablePojos(boolean generateSerializablePojos)
Whether generated POJO's should beSerializable
.void
setGenerateSources(boolean sourcesOnViews)
Whether source code should be generated on any object type.void
setGenerateSourcesOnViews(boolean sourcesOnViews)
Whether source code should be generated on views.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 generatedvoid
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 annotationsvoid
setGenerateVarargsSetters(boolean varargsSetters)
Whether varargs setters should be generated for array types.void
setGenerateVisibilityModifier(VisibilityModifier generateVisibilityModifier)
TheVisibilityModifier
that should be used in generated code.void
setMaxMembersPerInitialiser(int maxMembersPerInitialiser)
The maximum number of members per initialiser, to prevent reaching the 64kb byte code per method limit in generated code.void
setStrategy(GeneratorStrategy strategy)
Set a naming strategy to this generatorvoid
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 directoryvoid
setTargetEncoding(String encoding)
Initialise the target encodingvoid
setTargetLocale(Locale targetLocale)
The target locale.void
setTargetPackage(String packageName)
Initialise the target package namevoid
setUseCatalogVersionProvider(boolean useCatalogVersionProvider)
void
setUseSchemaVersionProvider(boolean useSchemaVersionProvider)
boolean
useCatalogVersionProvider()
boolean
useSchemaVersionProvider()
-
-
-
Method Detail
-
generate
void generate(Database database)
Do the code generation
-
setStrategy
void setStrategy(GeneratorStrategy strategy)
Set a naming strategy to this generator
-
getStrategy
GeneratorStrategy getStrategy()
Get this generator's underlying naming strategy
-
generateDeprecated
boolean generateDeprecated()
Whether deprecated code should be generated
-
setGenerateDeprecated
void setGenerateDeprecated(boolean generateDeprecated)
Whether deprecated code should be generated
-
generateDeprecationOnUnknownTypes
boolean generateDeprecationOnUnknownTypes()
Whether deprecation should be generated on unknown types.
-
setGenerateDeprecationOnUnknownTypes
void setGenerateDeprecationOnUnknownTypes(boolean generateDeprecationOnUnknownTypes)
Whether deprecation should be generated on unknown types.
-
generateIndexes
boolean generateIndexes()
Whether indexes should be generated.
-
setGenerateIndexes
void setGenerateIndexes(boolean generateIndexes)
Whether indexes should be generated.
-
generateRelations
boolean generateRelations()
Whether foreign key relations should be resolved
-
setGenerateRelations
void setGenerateRelations(boolean generateRelations)
Whether foreign key relations should be resolved
-
generateImplicitJoinPathsToOne
boolean generateImplicitJoinPathsToOne()
Whether implicit join path constructors on generated tables for outgoing foreign key relationships (to-one relationships) should be generated.
-
setGenerateImplicitJoinPathsToOne
void setGenerateImplicitJoinPathsToOne(boolean generateImplicitJoinPathsToOne)
Whether implicit join path constructors on generated tables for outgoing foreign key relationships (to-one relationships) should be generated.
-
generateTableValuedFunctions
boolean generateTableValuedFunctions()
Whether table-valued functions should be generated as tables.
-
setGenerateTableValuedFunctions
void setGenerateTableValuedFunctions(boolean generateTableValuedFunctions)
Whether table-valued functions should be generated as tables.
-
generateInstanceFields
boolean generateInstanceFields()
Whether instance fields should be generated (as opposed to static fields).
-
setGenerateInstanceFields
void setGenerateInstanceFields(boolean generateInstanceFields)
Whether instance fields should be generated (as opposed to static fields).
-
generateGeneratedAnnotation
boolean generateGeneratedAnnotation()
Whether thejavax.annotation.Generated
orGenerated
annotation should be generated.
-
setGenerateVisibilityModifier
void setGenerateVisibilityModifier(VisibilityModifier generateVisibilityModifier)
TheVisibilityModifier
that should be used in generated code.
-
generateVisibilityModifier
VisibilityModifier generateVisibilityModifier()
TheVisibilityModifier
that should be used in generated code.
-
setGenerateGeneratedAnnotation
void setGenerateGeneratedAnnotation(boolean generateGeneratedAnnotation)
Whether thejavax.annotation.Generated
orGenerated
annotation should be generated.
-
generateGeneratedAnnotationType
GeneratedAnnotationType generateGeneratedAnnotationType()
Whether thejavax.annotation.Generated
orGenerated
annotation should be generated.
-
setGenerateGeneratedAnnotationType
void setGenerateGeneratedAnnotationType(GeneratedAnnotationType generateGeneratedAnnotationType)
Whether thejavax.annotation.Generated
orGenerated
annotation should be generated.
-
generateGeneratedAnnotationDate
boolean generateGeneratedAnnotationDate()
-
setGenerateGeneratedAnnotationDate
void setGenerateGeneratedAnnotationDate(boolean generateGeneratedAnnotationDate)
-
generateNonnullAnnotation
boolean generateNonnullAnnotation()
Whether Nonnull annotations should be generated.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!
-
setGenerateNonnullAnnotation
void setGenerateNonnullAnnotation(boolean generateNonnullAnnotation)
Whether Nonnull annotations should be generated.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!
-
generatedNonnullAnnotationType
String generatedNonnullAnnotationType()
Which type of Nonnull annotation should be generated.
-
setGeneratedNonnullAnnotationType
void setGeneratedNonnullAnnotationType(String generatedNonnullAnnotationType)
Which type of Nonnull annotation should be generated.
-
generateNullableAnnotation
boolean generateNullableAnnotation()
Whether Nullable annotations should be generated.Unlike
generateNonnullAnnotation()
, nullability can be guaranteed as in SQL, and by consequence in jOOQ, every column expression can be made nullable using some SQL operation.
-
setGenerateNullableAnnotation
void setGenerateNullableAnnotation(boolean generateNullableAnnotation)
Whether Nullable annotations should be generated.Unlike
generateNonnullAnnotation()
, nullability can be guaranteed as in SQL, and by consequence in jOOQ, every column expression can be made nullable using some SQL operation.
-
generatedNullableAnnotationType
String generatedNullableAnnotationType()
Which type of Nullable annotation should be generated.
-
setGeneratedNullableAnnotationType
void setGeneratedNullableAnnotationType(String generatedNullableAnnotationType)
Which type of Nullable annotation should be generated.
-
setGenerateConstructorPropertiesAnnotation
void setGenerateConstructorPropertiesAnnotation(boolean generateConstructorPropertiesAnnotation)
Whether theConstructorProperties
annotation should be generated.
-
generateConstructorPropertiesAnnotation
boolean generateConstructorPropertiesAnnotation()
Whether theConstructorProperties
annotation should be generated.
-
setGenerateConstructorPropertiesAnnotationOnPojos
void setGenerateConstructorPropertiesAnnotationOnPojos(boolean generateConstructorPropertiesAnnotationOnPojos)
Whether theConstructorProperties
annotation should be generated on POJOs.
-
generateConstructorPropertiesAnnotationOnPojos
boolean generateConstructorPropertiesAnnotationOnPojos()
Whether theConstructorProperties
annotation should be generated on POJOs.
-
setGenerateConstructorPropertiesAnnotationOnRecords
void setGenerateConstructorPropertiesAnnotationOnRecords(boolean generateConstructorPropertiesAnnotationOnRecords)
Whether theConstructorProperties
annotation should be generated on records.
-
generateConstructorPropertiesAnnotationOnRecords
boolean generateConstructorPropertiesAnnotationOnRecords()
Whether theConstructorProperties
annotation should be generated on records.
-
useSchemaVersionProvider
boolean useSchemaVersionProvider()
-
setUseSchemaVersionProvider
void setUseSchemaVersionProvider(boolean useSchemaVersionProvider)
-
useCatalogVersionProvider
boolean useCatalogVersionProvider()
-
setUseCatalogVersionProvider
void setUseCatalogVersionProvider(boolean useCatalogVersionProvider)
-
generateRoutines
boolean generateRoutines()
Whether Routines should be generated.
-
setGenerateRoutines
void setGenerateRoutines(boolean generateRoutines)
Whether Routines should be generated.
-
generateSequences
boolean generateSequences()
Whether Sequences should be generated.
-
setGenerateSequences
void setGenerateSequences(boolean generateSequences)
Whether Sequences should be generated.
-
generateSequenceFlags
boolean generateSequenceFlags()
Whether sequence flags should be generated.
-
setGenerateSequenceFlags
void setGenerateSequenceFlags(boolean generateSequenceFlags)
Whether sequence flags should be generated.
-
generateUDTs
boolean generateUDTs()
Whether UDTs should be generated.
-
setGenerateUDTs
void setGenerateUDTs(boolean generateUDTs)
Whether UDTs should be generated.
-
generateTables
boolean generateTables()
Whether Tables should be generated
-
setGenerateTables
void setGenerateTables(boolean generateTables)
Whether Tables should be generated
-
generateEmbeddables
boolean generateEmbeddables()
Whether embeddable types should be generated
-
setGenerateEmbeddables
void setGenerateEmbeddables(boolean generateEmbeddables)
Whether embeddable types should be generated
-
generateRecords
boolean generateRecords()
Whether TableRecords should be generated in addition to tables
-
setGenerateRecords
void setGenerateRecords(boolean generateRecords)
Whether TableRecords should be generated in addition to tables
-
generateRecordsImplementingRecordN
boolean generateRecordsImplementingRecordN()
Whether TableRecords should be generated in addition to tables, which implement Record[N] types
-
setGenerateRecordsImplementingRecordN
void setGenerateRecordsImplementingRecordN(boolean generateRecordsImplementingRecordN)
Whether TableRecords should be generated in addition to tables, which implement Record[N] types
-
generateEnumsAsScalaSealedTraits
@Deprecated boolean generateEnumsAsScalaSealedTraits()
Deprecated.- [#10998] - 3.15.0 - This is maintained for backwards compatibility only. Do not reuse this feature, if possibleWhether enums generated as Scala sealed traits by theScalaGenerator
.
-
setGenerateEnumsAsScalaSealedTraits
@Deprecated void setGenerateEnumsAsScalaSealedTraits(boolean generateEnumsAsScalaSealedTraits)
Deprecated.- [#10998] - 3.15.0 - This is maintained for backwards compatibility only. Do not reuse this feature, if possibleWhether enums generated as Scala sealed traits by theScalaGenerator
.
-
generatePojos
boolean generatePojos()
Whether POJO's should be generated in addition to records
-
setGeneratePojos
void setGeneratePojos(boolean generatePojos)
Whether POJO's should be generated in addition to records
-
generatePojosAsJavaRecordClasses
boolean generatePojosAsJavaRecordClasses()
Whether POJOs should be generated as Java records by theJavaGenerator
.
-
setGeneratePojosAsJavaRecordClasses
void setGeneratePojosAsJavaRecordClasses(boolean pojosAsJavaRecordClasses)
Whether POJOs should be generated as Java records by theJavaGenerator
.
-
generatePojosAsScalaCaseClasses
boolean generatePojosAsScalaCaseClasses()
Whether POJOs should be generated as Scala case classes by theScalaGenerator
.
-
setGeneratePojosAsScalaCaseClasses
void setGeneratePojosAsScalaCaseClasses(boolean pojosAsScalaCaseClasses)
Whether POJOs should be generated as Scala case classes by theScalaGenerator
.
-
generatePojosAsKotlinDataClasses
boolean generatePojosAsKotlinDataClasses()
Whether POJOs should be generated as Kotlin data classes by theKotlinGenerator
.
-
setGeneratePojosAsKotlinDataClasses
void setGeneratePojosAsKotlinDataClasses(boolean pojosAsKotlinDataClasses)
Whether POJOs should be generated as Kotlin data classes by theKotlinGenerator
.
-
generateImmutablePojos
boolean generateImmutablePojos()
Whether immutable POJO's should be generated in addition to records
-
setGenerateImmutablePojos
void setGenerateImmutablePojos(boolean generateImmutablePojos)
Whether immutable POJO's should be generated in addition to records
-
generateSerializablePojos
boolean generateSerializablePojos()
Whether generated POJO's should beSerializable
.
-
setGenerateSerializablePojos
void setGenerateSerializablePojos(boolean generateSerializablePojos)
Whether generated POJO's should beSerializable
.
-
generateInterfaces
boolean generateInterfaces()
Whether interfaces should be generated to be implemented by records and POJO's
-
setGenerateInterfaces
void setGenerateInterfaces(boolean generateInterfaces)
Whether interfaces should be generated to be implemented by records and POJO's
-
generateImmutableInterfaces
boolean generateImmutableInterfaces()
Whether immutable interfaces should be generated in addition to records
-
setGenerateImmutableInterfaces
void setGenerateImmutableInterfaces(boolean generateImmutableInterfaces)
Whether immutable interfaces should be generated in addition to records
-
generateSerializableInterfaces
boolean generateSerializableInterfaces()
Whether generated interfaces should extendSerializable
.
-
setGenerateSerializableInterfaces
void setGenerateSerializableInterfaces(boolean generateSerializableInterfaces)
Whether generated interfaces should extendSerializable
.
-
generateDaos
boolean generateDaos()
Whether DAO's should be generated in addition to pojos
-
setGenerateDaos
void setGenerateDaos(boolean generateDaos)
Whether DAO's should be generated in addition to pojos
-
generateJPAAnnotations
boolean generateJPAAnnotations()
Whether POJO's and records should be annotated with JPA annotations
-
setGenerateJPAAnnotations
void setGenerateJPAAnnotations(boolean generateJPAAnnotations)
Whether POJO's and records should be annotated with JPA annotations
-
generateJPAVersion
String generateJPAVersion()
The minimum JPA version that is supported by generated code (latest version if empty).
-
setGenerateJPAVersion
void setGenerateJPAVersion(String generateJPAVersion)
The minimum JPA version that is supported by generated code (latest version if empty).
-
generateValidationAnnotations
boolean generateValidationAnnotations()
Whether POJO's and records should be annotated with JSR-303 validation annotations
-
setGenerateValidationAnnotations
void setGenerateValidationAnnotations(boolean generateValidationAnnotations)
Whether POJO's and records should be annotated with JSR-303 validation annotations
-
generateSpringAnnotations
boolean generateSpringAnnotations()
Whether DAOs should be annotated with useful spring annotations such as@Repository
or@Autowired
-
setGenerateSpringAnnotations
void setGenerateSpringAnnotations(boolean generateSpringAnnotations)
Whether DAOs should be annotated with useful spring annotations such as@Repository
or@Autowired
-
generateKotlinSetterJvmNameAnnotationsOnIsPrefix
boolean generateKotlinSetterJvmNameAnnotationsOnIsPrefix()
Whether kotlin mutable properties should be annotated withset:JvmName
as a workaround for problems occurring when kotlin producessetX()
instead ofsetIsX()
setters for anisX
property.
-
setGenerateKotlinSetterJvmNameAnnotationsOnIsPrefix
void setGenerateKotlinSetterJvmNameAnnotationsOnIsPrefix(boolean generateKotlinSetterJvmNameAnnotationsOnIsPrefix)
Whether kotlin mutable properties should be annotated withset:JvmName
as a workaround for problems occurring when kotlin producessetX()
instead ofsetIsX()
setters for anisX
property.
-
generatedSerialVersionUID
GeneratedSerialVersionUID generatedSerialVersionUID()
The type ofserialVersionUID
that should be generated.
-
setGenerateGeneratedSerialVersionUID
void setGenerateGeneratedSerialVersionUID(GeneratedSerialVersionUID generatedSerialVersionUID)
The type ofserialVersionUID
that should be generated.
-
maxMembersPerInitialiser
int maxMembersPerInitialiser()
The maximum number of members per initialiser, to prevent reaching the 64kb byte code per method limit in generated code.
-
setMaxMembersPerInitialiser
void setMaxMembersPerInitialiser(int maxMembersPerInitialiser)
The maximum number of members per initialiser, to prevent reaching the 64kb byte code per method limit in generated code.
-
generateGlobalObjectReferences
boolean generateGlobalObjectReferences()
Whether global object references should be generated
-
setGenerateGlobalObjectReferences
void setGenerateGlobalObjectReferences(boolean generateGlobalObjectReferences)
Whether global object references should be generated
-
generateGlobalCatalogReferences
boolean generateGlobalCatalogReferences()
Whether global catalog references should be generated
-
setGenerateGlobalCatalogReferences
void setGenerateGlobalCatalogReferences(boolean globalCatalogReferences)
Whether global catalog references should be generated
-
generateGlobalSchemaReferences
boolean generateGlobalSchemaReferences()
Whether global schema references should be generated
-
setGenerateGlobalSchemaReferences
void setGenerateGlobalSchemaReferences(boolean globalSchemaReferences)
Whether global schema references should be generated
-
generateGlobalRoutineReferences
boolean generateGlobalRoutineReferences()
Whether global routine references should be generated
-
setGenerateGlobalRoutineReferences
void setGenerateGlobalRoutineReferences(boolean globalRoutineReferences)
Whether global routine references should be generated
-
generateGlobalSequenceReferences
boolean generateGlobalSequenceReferences()
Whether global sequence references should be generated
-
setGenerateGlobalSequenceReferences
void setGenerateGlobalSequenceReferences(boolean globalSequenceReferences)
Whether global sequence references should be generated
-
generateGlobalTableReferences
boolean generateGlobalTableReferences()
Whether global table references should be generated
-
setGenerateGlobalTableReferences
void setGenerateGlobalTableReferences(boolean globalTableReferences)
Whether global table references should be generated
-
generateGlobalUDTReferences
boolean generateGlobalUDTReferences()
Whether global UDT references should be generated
-
setGenerateGlobalUDTReferences
void setGenerateGlobalUDTReferences(boolean globalUDTReferences)
Whether global UDT references should be generated
-
generateGlobalDomainReferences
boolean generateGlobalDomainReferences()
Whether global domain references should be generated
-
setGenerateGlobalDomainReferences
void setGenerateGlobalDomainReferences(boolean globalDomainReferences)
Whether global domain references should be generated
-
generateGlobalQueueReferences
boolean generateGlobalQueueReferences()
Whether global queue references should be generated
-
setGenerateGlobalQueueReferences
void setGenerateGlobalQueueReferences(boolean globalQueueReferences)
Whether global queue references should be generated
-
generateGlobalLinkReferences
boolean generateGlobalLinkReferences()
Whether global link references should be generated
-
setGenerateGlobalLinkReferences
void setGenerateGlobalLinkReferences(boolean globalLinkReferences)
Whether global link references should be generated
-
generateGlobalKeyReferences
boolean generateGlobalKeyReferences()
Whether global key references should be generated
-
setGenerateGlobalKeyReferences
void setGenerateGlobalKeyReferences(boolean globalKeyReferences)
Whether global key references should be generated
-
generateGlobalIndexReferences
boolean generateGlobalIndexReferences()
Whether global index references should be generated
-
setGenerateGlobalIndexReferences
void setGenerateGlobalIndexReferences(boolean globalIndexReferences)
Whether global index references should be generated
-
generateJavadoc
boolean generateJavadoc()
Whether any Javadoc should be generated.
-
setGenerateJavadoc
void setGenerateJavadoc(boolean javadoc)
Whether any Javadoc should be generated.
-
generateComments
boolean generateComments()
Whether any SQL comments should be generated as Javadoc.
-
setGenerateComments
void setGenerateComments(boolean comments)
Whether any SQL comments should be generated as Javadoc.
-
generateCommentsOnAttributes
boolean generateCommentsOnAttributes()
Whether SQL comments on attributes should be generated as Javadoc.
-
setGenerateCommentsOnAttributes
void setGenerateCommentsOnAttributes(boolean commentsOnAttributes)
Whether SQL comments on attributes should be generated as Javadoc.
-
generateCommentsOnCatalogs
boolean generateCommentsOnCatalogs()
Whether SQL comments on catalogs should be generated as Javadoc.
-
setGenerateCommentsOnCatalogs
void setGenerateCommentsOnCatalogs(boolean commentsOnCatalogs)
Whether SQL comments on catalogs should be generated as Javadoc.
-
generateCommentsOnColumns
boolean generateCommentsOnColumns()
Whether SQL comments on columns should be generated as Javadoc.
-
setGenerateCommentsOnColumns
void setGenerateCommentsOnColumns(boolean commentsOnColumns)
Whether SQL comments on columns should be generated as Javadoc.
-
generateCommentsOnKeys
boolean generateCommentsOnKeys()
Whether SQL comments on keys should be generated as Javadoc.
-
setGenerateCommentsOnKeys
void setGenerateCommentsOnKeys(boolean commentsOnKeys)
Whether SQL comments on keys should be generated as Javadoc.
-
generateCommentsOnLinks
boolean generateCommentsOnLinks()
Whether SQL comments on links should be generated as Javadoc.
-
setGenerateCommentsOnLinks
void setGenerateCommentsOnLinks(boolean commentsOnLinks)
Whether SQL comments on links should be generated as Javadoc.
-
generateCommentsOnPackages
boolean generateCommentsOnPackages()
Whether SQL comments on packages should be generated as Javadoc.
-
setGenerateCommentsOnPackages
void setGenerateCommentsOnPackages(boolean commentsOnPackages)
Whether SQL comments on packages should be generated as Javadoc.
-
generateCommentsOnParameters
boolean generateCommentsOnParameters()
Whether SQL comments on parameters should be generated as Javadoc.
-
setGenerateCommentsOnParameters
void setGenerateCommentsOnParameters(boolean commentsOnParameters)
Whether SQL comments on parameters should be generated as Javadoc.
-
generateCommentsOnQueues
boolean generateCommentsOnQueues()
Whether SQL comments on queues should be generated as Javadoc.
-
setGenerateCommentsOnQueues
void setGenerateCommentsOnQueues(boolean commentsOnQueues)
Whether SQL comments on queues should be generated as Javadoc.
-
generateCommentsOnRoutines
boolean generateCommentsOnRoutines()
Whether SQL comments on routines should be generated as Javadoc.
-
setGenerateCommentsOnRoutines
void setGenerateCommentsOnRoutines(boolean commentsOnRoutines)
Whether SQL comments on routines should be generated as Javadoc.
-
generateCommentsOnSchemas
boolean generateCommentsOnSchemas()
Whether SQL comments on schemas should be generated as Javadoc.
-
setGenerateCommentsOnSchemas
void setGenerateCommentsOnSchemas(boolean commentsOnSchemas)
Whether SQL comments on schemas should be generated as Javadoc.
-
generateCommentsOnSequences
boolean generateCommentsOnSequences()
Whether SQL comments on sequences should be generated as Javadoc.
-
setGenerateCommentsOnSequences
void setGenerateCommentsOnSequences(boolean commentsOnSequences)
Whether SQL comments on sequences should be generated as Javadoc.
-
generateCommentsOnTables
boolean generateCommentsOnTables()
Whether SQL comments on tables should be generated as Javadoc.
-
setGenerateCommentsOnTables
void setGenerateCommentsOnTables(boolean commentsOnTables)
Whether SQL comments on tables should be generated as Javadoc.
-
generateCommentsOnEmbeddables
boolean generateCommentsOnEmbeddables()
Whether SQL comments on embeddables should be generated as Javadoc.
-
setGenerateCommentsOnEmbeddables
void setGenerateCommentsOnEmbeddables(boolean commentsOnEmbeddables)
Whether SQL comments on embeddables should be generated as Javadoc.
-
generateCommentsOnUDTs
boolean generateCommentsOnUDTs()
Whether SQL comments on UDTs should be generated as Javadoc.
-
setGenerateCommentsOnUDTs
void setGenerateCommentsOnUDTs(boolean commentsOnUDTs)
Whether SQL comments on UDTs should be generated as Javadoc.
-
generateSources
boolean generateSources()
Whether source code should be generated on any object type.
-
setGenerateSources
void setGenerateSources(boolean sourcesOnViews)
Whether source code should be generated on any object type.
-
generateSourcesOnViews
boolean generateSourcesOnViews()
Whether source code should be generated on views.
-
setGenerateSourcesOnViews
void setGenerateSourcesOnViews(boolean sourcesOnViews)
Whether source code should be generated on views.
-
generateQueues
boolean generateQueues()
Whether queue related code should be generated
-
setGenerateQueues
void setGenerateQueues(boolean queues)
Whether queue related code should be generated
-
generateLinks
boolean generateLinks()
Whether link related code should be generated
-
setGenerateLinks
void setGenerateLinks(boolean links)
Whether link related code should be generated
-
generateKeys
boolean generateKeys()
Whether key related code should be generated
-
setGenerateKeys
void setGenerateKeys(boolean keys)
Whether key related code should be generated
-
fluentSetters
@Deprecated boolean fluentSetters()
Deprecated.- UsegenerateFluentSetters()
instead.Whether fluent setters should be generated
-
setFluentSetters
@Deprecated void setFluentSetters(boolean fluentSetters)
Deprecated.- UsesetGenerateFluentSetters(boolean)
instead.Whether fluent setters should be generated
-
generateFluentSetters
boolean generateFluentSetters()
Whether fluent setters should be generated
-
setGenerateFluentSetters
void setGenerateFluentSetters(boolean fluentSetters)
Whether fluent setters should be generated
-
generateJavaBeansGettersAndSetters
boolean generateJavaBeansGettersAndSetters()
Whether getters and setters should be generated JavaBeans style (or jOOQ style).
-
setGenerateJavaBeansGettersAndSetters
void setGenerateJavaBeansGettersAndSetters(boolean javaBeansGettersAndSetters)
Whether getters and setters should be generated JavaBeans style (or jOOQ style).
-
generateVarargsSetters
boolean generateVarargsSetters()
Whether varargs setters should be generated for array types.
-
setGenerateVarargsSetters
void setGenerateVarargsSetters(boolean varargsSetters)
Whether varargs setters should be generated for array types.
-
generatePojosEqualsAndHashCode
boolean generatePojosEqualsAndHashCode()
Whetherequals()
andhashCode()
methods should be generated on POJOs
-
setGeneratePojosEqualsAndHashCode
void setGeneratePojosEqualsAndHashCode(boolean generatePojosEqualsAndHashCode)
Whetherequals()
andhashCode()
methods should be generated on POJOs
-
generatePojosToString
boolean generatePojosToString()
Whether atoString()
method should be generated on POJOs
-
setGeneratePojosToString
void setGeneratePojosToString(boolean generatePojosToString)
Whether atoString()
method should be generated on POJOs
-
fullyQualifiedTypes
@Deprecated String fullyQualifiedTypes()
Deprecated.- UsegenerateFullyQualifiedTypes()
instead.A regular expression matching all the types in generated code that should be fully qualified.
-
setFullyQualifiedTypes
@Deprecated void setFullyQualifiedTypes(String fullyQualifiedTypes)
Deprecated.- UsesetGenerateFullyQualifiedTypes(String)
instead.A regular expression matching all the types in generated code that should be fully qualified.
-
generateFullyQualifiedTypes
String generateFullyQualifiedTypes()
A regular expression matching all the types in generated code that should be fully qualified.
-
setGenerateFullyQualifiedTypes
void setGenerateFullyQualifiedTypes(String generateFullyQualifiedTypes)
A regular expression matching all the types in generated code that should be fully qualified.
-
generateJavaTimeTypes
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.This flag is ignored in the commercial Java 6 distribution of jOOQ 3.9+
-
setGenerateJavaTimeTypes
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.This flag is ignored in the commercial Java 6 distribution of jOOQ 3.9+
-
generateEmptyCatalogs
boolean generateEmptyCatalogs()
Whether empty catalogs should still be generated.
-
setGenerateEmptyCatalogs
void setGenerateEmptyCatalogs(boolean generateEmptyCatalogs)
Whether empty catalogs should still be generated.
-
generateEmptySchemas
boolean generateEmptySchemas()
Whether empty schemas should still be generated.
-
setGenerateEmptySchemas
void setGenerateEmptySchemas(boolean generateEmptySchemas)
Whether empty schemas should still be generated.
-
generateNewline
String generateNewline()
The newline character(s) to be used in generated code.
-
setGenerateNewline
void setGenerateNewline(String newline)
The newline character(s) to be used in generated code.
-
generateIndentation
String generateIndentation()
The indentation character(s) to be used in generated code.
-
setGenerateIndentation
void setGenerateIndentation(String indentation)
The indentation character(s) to be used in generated code.
-
generatePrintMarginForBlockComment
int generatePrintMarginForBlockComment()
The print margin for Javadoc and other block comments to be used in generated code.
-
setGeneratePrintMarginForBlockComment
void setGeneratePrintMarginForBlockComment(int printMarginForBlockComment)
The print margin for Javadoc and other block comments to be used in generated code.
-
getTargetDirectory
String getTargetDirectory()
The target directory
-
setTargetDirectory
void setTargetDirectory(String directory)
Initialise the target directory
-
getTargetEncoding
String getTargetEncoding()
The target encoding
-
setTargetEncoding
void setTargetEncoding(String encoding)
Initialise the target encoding
-
getTargetPackage
String getTargetPackage()
- Returns:
- Get the target package for the current configuration
-
setTargetPackage
void setTargetPackage(String packageName)
Initialise the target package name
-
getTargetClean
boolean getTargetClean()
Whether the target package should be cleaned to contain only generated code after a generation run.
-
setTargetClean
void setTargetClean(boolean clean)
Whether the target package should be cleaned to contain only generated code after a generation run.
-
getTargetLocale
Locale getTargetLocale()
The target locale.
-
setTargetLocale
void setTargetLocale(Locale targetLocale)
The target locale.
-
-