Class XMLGenerator

  • All Implemented Interfaces:
    Generator

    public class XMLGenerator
    extends Object
    Author:
    Lukas Eder
    • Field Detail

      • strategy

        protected org.jooq.codegen.GeneratorStrategyWrapper strategy
      • targetEncoding

        protected String targetEncoding
      • targetClean

        protected boolean targetClean
    • Constructor Detail

      • XMLGenerator

        public XMLGenerator()
    • Method Detail

      • generate0

        public void generate0​(Database db)
      • generateDeprecated

        public boolean generateDeprecated()
        Description copied from interface: Generator
        Whether deprecated code should be generated
        Specified by:
        generateDeprecated in interface Generator
      • setGenerateDeprecated

        public void setGenerateDeprecated​(boolean generateDeprecated)
        Description copied from interface: Generator
        Whether deprecated code should be generated
        Specified by:
        setGenerateDeprecated in interface Generator
      • generateDeprecationOnUnknownTypes

        public boolean generateDeprecationOnUnknownTypes()
        Description copied from interface: Generator
        Whether deprecation should be generated on unknown types.
        Specified by:
        generateDeprecationOnUnknownTypes in interface Generator
      • setGenerateDeprecationOnUnknownTypes

        public void setGenerateDeprecationOnUnknownTypes​(boolean generateDeprecationOnUnknownTypes)
        Description copied from interface: Generator
        Whether deprecation should be generated on unknown types.
        Specified by:
        setGenerateDeprecationOnUnknownTypes in interface Generator
      • generateIndexes

        public boolean generateIndexes()
        Description copied from interface: Generator
        Whether indexes should be generated.
        Specified by:
        generateIndexes in interface Generator
      • setGenerateIndexes

        public void setGenerateIndexes​(boolean generateIndexes)
        Description copied from interface: Generator
        Whether indexes should be generated.
        Specified by:
        setGenerateIndexes in interface Generator
      • generateRelations

        public boolean generateRelations()
        Description copied from interface: Generator
        Whether foreign key relations should be resolved
        Specified by:
        generateRelations in interface Generator
      • setGenerateRelations

        public void setGenerateRelations​(boolean generateRelations)
        Description copied from interface: Generator
        Whether foreign key relations should be resolved
        Specified by:
        setGenerateRelations in interface Generator
      • generateImplicitJoinPathsToOne

        public boolean generateImplicitJoinPathsToOne()
        Description copied from interface: Generator
        Whether implicit join path constructors on generated tables for outgoing foreign key relationships (to-one relationships) should be generated.
        Specified by:
        generateImplicitJoinPathsToOne in interface Generator
      • setGenerateImplicitJoinPathsToOne

        public void setGenerateImplicitJoinPathsToOne​(boolean generateImplicitJoinPathsToOne)
        Description copied from interface: Generator
        Whether implicit join path constructors on generated tables for outgoing foreign key relationships (to-one relationships) should be generated.
        Specified by:
        setGenerateImplicitJoinPathsToOne in interface Generator
      • generateTableValuedFunctions

        public boolean generateTableValuedFunctions()
        Description copied from interface: Generator
        Whether table-valued functions should be generated as tables.
        Specified by:
        generateTableValuedFunctions in interface Generator
      • setGenerateTableValuedFunctions

        public void setGenerateTableValuedFunctions​(boolean generateTableValuedFunctions)
        Description copied from interface: Generator
        Whether table-valued functions should be generated as tables.
        Specified by:
        setGenerateTableValuedFunctions in interface Generator
      • generateInstanceFields

        public boolean generateInstanceFields()
        Description copied from interface: Generator
        Whether instance fields should be generated (as opposed to static fields).
        Specified by:
        generateInstanceFields in interface Generator
      • setGenerateInstanceFields

        public void setGenerateInstanceFields​(boolean generateInstanceFields)
        Description copied from interface: Generator
        Whether instance fields should be generated (as opposed to static fields).
        Specified by:
        setGenerateInstanceFields in interface Generator
      • setGenerateGeneratedAnnotation

        public void setGenerateGeneratedAnnotation​(boolean generateGeneratedAnnotation)
        Description copied from interface: Generator
        Whether the Generated annotation should be generated.
        Specified by:
        setGenerateGeneratedAnnotation in interface Generator
      • setGenerateGeneratedAnnotationDate

        public void setGenerateGeneratedAnnotationDate​(boolean generateGeneratedAnnotationDate)
        Description copied from interface: Generator
        Whether the Generated annotation should include the date attribute.
        Specified by:
        setGenerateGeneratedAnnotationDate in interface Generator
      • generateNonnullAnnotation

        public boolean generateNonnullAnnotation()
        Description copied from interface: Generator
        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!

        Specified by:
        generateNonnullAnnotation in interface Generator
      • setGenerateNonnullAnnotation

        public void setGenerateNonnullAnnotation​(boolean generateNonnullAnnotation)
        Description copied from interface: Generator
        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!

        Specified by:
        setGenerateNonnullAnnotation in interface Generator
      • setGeneratedNonnullAnnotationType

        public void setGeneratedNonnullAnnotationType​(String generatedNonnullAnnotationType)
        Description copied from interface: Generator
        Which type of Nonnull annotation should be generated.
        Specified by:
        setGeneratedNonnullAnnotationType in interface Generator
      • generateNullableAnnotation

        public boolean generateNullableAnnotation()
        Description copied from interface: Generator
        Whether Nullable annotations should be generated.

        Unlike Generator.generateNonnullAnnotation(), nullability can be guaranteed as in SQL, and by consequence in jOOQ, every column expression can be made nullable using some SQL operation.

        Specified by:
        generateNullableAnnotation in interface Generator
      • setGenerateNullableAnnotation

        public void setGenerateNullableAnnotation​(boolean generateNullableAnnotation)
        Description copied from interface: Generator
        Whether Nullable annotations should be generated.

        Unlike Generator.generateNonnullAnnotation(), nullability can be guaranteed as in SQL, and by consequence in jOOQ, every column expression can be made nullable using some SQL operation.

        Specified by:
        setGenerateNullableAnnotation in interface Generator
      • setGeneratedNullableAnnotationType

        public void setGeneratedNullableAnnotationType​(String generatedNullableAnnotationType)
        Description copied from interface: Generator
        Which type of Nullable annotation should be generated.
        Specified by:
        setGeneratedNullableAnnotationType in interface Generator
      • setGenerateConstructorPropertiesAnnotation

        public void setGenerateConstructorPropertiesAnnotation​(boolean generateConstructorPropertiesAnnotation)
        Description copied from interface: Generator
        Whether the ConstructorProperties annotation should be generated.
        Specified by:
        setGenerateConstructorPropertiesAnnotation in interface Generator
      • generateConstructorPropertiesAnnotation

        public boolean generateConstructorPropertiesAnnotation()
        Description copied from interface: Generator
        Whether the ConstructorProperties annotation should be generated.
        Specified by:
        generateConstructorPropertiesAnnotation in interface Generator
      • setGenerateConstructorPropertiesAnnotationOnPojos

        public void setGenerateConstructorPropertiesAnnotationOnPojos​(boolean generateConstructorPropertiesAnnotationOnPojos)
        Description copied from interface: Generator
        Whether the ConstructorProperties annotation should be generated on POJOs.
        Specified by:
        setGenerateConstructorPropertiesAnnotationOnPojos in interface Generator
      • generateConstructorPropertiesAnnotationOnPojos

        public boolean generateConstructorPropertiesAnnotationOnPojos()
        Description copied from interface: Generator
        Whether the ConstructorProperties annotation should be generated on POJOs.
        Specified by:
        generateConstructorPropertiesAnnotationOnPojos in interface Generator
      • setGenerateConstructorPropertiesAnnotationOnRecords

        public void setGenerateConstructorPropertiesAnnotationOnRecords​(boolean generateConstructorPropertiesAnnotationOnRecords)
        Description copied from interface: Generator
        Whether the ConstructorProperties annotation should be generated on records.
        Specified by:
        setGenerateConstructorPropertiesAnnotationOnRecords in interface Generator
      • generateRoutines

        public boolean generateRoutines()
        Description copied from interface: Generator
        Whether Routines should be generated.
        Specified by:
        generateRoutines in interface Generator
      • setGenerateRoutines

        public void setGenerateRoutines​(boolean generateRoutines)
        Description copied from interface: Generator
        Whether Routines should be generated.
        Specified by:
        setGenerateRoutines in interface Generator
      • generateSequences

        public boolean generateSequences()
        Description copied from interface: Generator
        Whether Sequences should be generated.
        Specified by:
        generateSequences in interface Generator
      • setGenerateSequences

        public void setGenerateSequences​(boolean generateSequences)
        Description copied from interface: Generator
        Whether Sequences should be generated.
        Specified by:
        setGenerateSequences in interface Generator
      • generateSequenceFlags

        public boolean generateSequenceFlags()
        Description copied from interface: Generator
        Whether sequence flags should be generated.
        Specified by:
        generateSequenceFlags in interface Generator
      • setGenerateSequenceFlags

        public void setGenerateSequenceFlags​(boolean generateSequenceFlags)
        Description copied from interface: Generator
        Whether sequence flags should be generated.
        Specified by:
        setGenerateSequenceFlags in interface Generator
      • generateUDTs

        public boolean generateUDTs()
        Description copied from interface: Generator
        Whether UDTs should be generated.
        Specified by:
        generateUDTs in interface Generator
      • setGenerateUDTs

        public void setGenerateUDTs​(boolean generateUDTs)
        Description copied from interface: Generator
        Whether UDTs should be generated.
        Specified by:
        setGenerateUDTs in interface Generator
      • generateTables

        public boolean generateTables()
        Description copied from interface: Generator
        Whether Tables should be generated
        Specified by:
        generateTables in interface Generator
      • setGenerateTables

        public void setGenerateTables​(boolean generateTables)
        Description copied from interface: Generator
        Whether Tables should be generated
        Specified by:
        setGenerateTables in interface Generator
      • generateEmbeddables

        public boolean generateEmbeddables()
        Description copied from interface: Generator
        Whether embeddable types should be generated
        Specified by:
        generateEmbeddables in interface Generator
      • setGenerateEmbeddables

        public void setGenerateEmbeddables​(boolean generateEmbeddables)
        Description copied from interface: Generator
        Whether embeddable types should be generated
        Specified by:
        setGenerateEmbeddables in interface Generator
      • generateRecords

        public boolean generateRecords()
        Description copied from interface: Generator
        Whether TableRecords should be generated in addition to tables
        Specified by:
        generateRecords in interface Generator
      • setGenerateRecords

        public void setGenerateRecords​(boolean generateRecords)
        Description copied from interface: Generator
        Whether TableRecords should be generated in addition to tables
        Specified by:
        setGenerateRecords in interface Generator
      • generateRecordsImplementingRecordN

        public boolean generateRecordsImplementingRecordN()
        Description copied from interface: Generator
        Whether TableRecords should be generated in addition to tables, which implement Record[N] types
        Specified by:
        generateRecordsImplementingRecordN in interface Generator
      • setGenerateRecordsImplementingRecordN

        public void setGenerateRecordsImplementingRecordN​(boolean generateRecordsImplementingRecordN)
        Description copied from interface: Generator
        Whether TableRecords should be generated in addition to tables, which implement Record[N] types
        Specified by:
        setGenerateRecordsImplementingRecordN in interface Generator
      • generatePojos

        public boolean generatePojos()
        Description copied from interface: Generator
        Whether POJO's should be generated in addition to records
        Specified by:
        generatePojos in interface Generator
      • setGeneratePojos

        public void setGeneratePojos​(boolean generatePojos)
        Description copied from interface: Generator
        Whether POJO's should be generated in addition to records
        Specified by:
        setGeneratePojos in interface Generator
      • generateImmutablePojos

        public boolean generateImmutablePojos()
        Description copied from interface: Generator
        Whether immutable POJO's should be generated in addition to records
        Specified by:
        generateImmutablePojos in interface Generator
      • setGenerateImmutablePojos

        public void setGenerateImmutablePojos​(boolean generateImmutablePojos)
        Description copied from interface: Generator
        Whether immutable POJO's should be generated in addition to records
        Specified by:
        setGenerateImmutablePojos in interface Generator
      • generateInterfaces

        public boolean generateInterfaces()
        Description copied from interface: Generator
        Whether interfaces should be generated to be implemented by records and POJO's
        Specified by:
        generateInterfaces in interface Generator
      • setGenerateInterfaces

        public void setGenerateInterfaces​(boolean generateInterfaces)
        Description copied from interface: Generator
        Whether interfaces should be generated to be implemented by records and POJO's
        Specified by:
        setGenerateInterfaces in interface Generator
      • generateImmutableInterfaces

        public boolean generateImmutableInterfaces()
        Description copied from interface: Generator
        Whether immutable interfaces should be generated in addition to records
        Specified by:
        generateImmutableInterfaces in interface Generator
      • setGenerateImmutableInterfaces

        public void setGenerateImmutableInterfaces​(boolean generateImmutableInterfaces)
        Description copied from interface: Generator
        Whether immutable interfaces should be generated in addition to records
        Specified by:
        setGenerateImmutableInterfaces in interface Generator
      • generateDaos

        public boolean generateDaos()
        Description copied from interface: Generator
        Whether DAO's should be generated in addition to pojos
        Specified by:
        generateDaos in interface Generator
      • setGenerateDaos

        public void setGenerateDaos​(boolean generateDaos)
        Description copied from interface: Generator
        Whether DAO's should be generated in addition to pojos
        Specified by:
        setGenerateDaos in interface Generator
      • generateJPAAnnotations

        public boolean generateJPAAnnotations()
        Description copied from interface: Generator
        Whether POJO's and records should be annotated with JPA annotations
        Specified by:
        generateJPAAnnotations in interface Generator
      • setGenerateJPAAnnotations

        public void setGenerateJPAAnnotations​(boolean generateJPAAnnotations)
        Description copied from interface: Generator
        Whether POJO's and records should be annotated with JPA annotations
        Specified by:
        setGenerateJPAAnnotations in interface Generator
      • generateJPAVersion

        public String generateJPAVersion()
        Description copied from interface: Generator
        The minimum JPA version that is supported by generated code (latest version if empty).
        Specified by:
        generateJPAVersion in interface Generator
      • setGenerateJPAVersion

        public void setGenerateJPAVersion​(String generateJPAVersion)
        Description copied from interface: Generator
        The minimum JPA version that is supported by generated code (latest version if empty).
        Specified by:
        setGenerateJPAVersion in interface Generator
      • generateValidationAnnotations

        public boolean generateValidationAnnotations()
        Description copied from interface: Generator
        Whether POJO's and records should be annotated with JSR-303 validation annotations
        Specified by:
        generateValidationAnnotations in interface Generator
      • setGenerateValidationAnnotations

        public void setGenerateValidationAnnotations​(boolean generateValidationAnnotations)
        Description copied from interface: Generator
        Whether POJO's and records should be annotated with JSR-303 validation annotations
        Specified by:
        setGenerateValidationAnnotations in interface Generator
      • generateSpringAnnotations

        public boolean generateSpringAnnotations()
        Description copied from interface: Generator
        Whether DAOs should be annotated with useful spring annotations such as @Repository or @Autowired
        Specified by:
        generateSpringAnnotations in interface Generator
      • setGenerateSpringAnnotations

        public void setGenerateSpringAnnotations​(boolean generateSpringAnnotations)
        Description copied from interface: Generator
        Whether DAOs should be annotated with useful spring annotations such as @Repository or @Autowired
        Specified by:
        setGenerateSpringAnnotations in interface Generator
      • generateKotlinSetterJvmNameAnnotationsOnIsPrefix

        public boolean generateKotlinSetterJvmNameAnnotationsOnIsPrefix()
        Description copied from interface: Generator
        Whether kotlin mutable properties should be annotated with set:JvmName as a workaround for problems occurring when kotlin produces setX() instead of setIsX() setters for an isX property.
        Specified by:
        generateKotlinSetterJvmNameAnnotationsOnIsPrefix in interface Generator
      • setGenerateKotlinSetterJvmNameAnnotationsOnIsPrefix

        public void setGenerateKotlinSetterJvmNameAnnotationsOnIsPrefix​(boolean generateKotlinSetterJvmNameAnnotationsOnIsPrefix)
        Description copied from interface: Generator
        Whether kotlin mutable properties should be annotated with set:JvmName as a workaround for problems occurring when kotlin produces setX() instead of setIsX() setters for an isX property.
        Specified by:
        setGenerateKotlinSetterJvmNameAnnotationsOnIsPrefix in interface Generator
      • maxMembersPerInitialiser

        public int maxMembersPerInitialiser()
        Description copied from interface: Generator
        The maximum number of members per initialiser, to prevent reaching the 64kb byte code per method limit in generated code.
        Specified by:
        maxMembersPerInitialiser in interface Generator
      • setMaxMembersPerInitialiser

        public void setMaxMembersPerInitialiser​(int maxMembersPerInitialiser)
        Description copied from interface: Generator
        The maximum number of members per initialiser, to prevent reaching the 64kb byte code per method limit in generated code.
        Specified by:
        setMaxMembersPerInitialiser in interface Generator
      • generateGlobalObjectReferences

        public boolean generateGlobalObjectReferences()
        Description copied from interface: Generator
        Whether global object references should be generated
        Specified by:
        generateGlobalObjectReferences in interface Generator
      • setGenerateGlobalObjectReferences

        public void setGenerateGlobalObjectReferences​(boolean generateGlobalObjectReferences)
        Description copied from interface: Generator
        Whether global object references should be generated
        Specified by:
        setGenerateGlobalObjectReferences in interface Generator
      • generateGlobalCatalogReferences

        public boolean generateGlobalCatalogReferences()
        Description copied from interface: Generator
        Whether global catalog references should be generated
        Specified by:
        generateGlobalCatalogReferences in interface Generator
      • setGenerateGlobalCatalogReferences

        public void setGenerateGlobalCatalogReferences​(boolean globalCatalogReferences)
        Description copied from interface: Generator
        Whether global catalog references should be generated
        Specified by:
        setGenerateGlobalCatalogReferences in interface Generator
      • generateGlobalSchemaReferences

        public boolean generateGlobalSchemaReferences()
        Description copied from interface: Generator
        Whether global schema references should be generated
        Specified by:
        generateGlobalSchemaReferences in interface Generator
      • setGenerateGlobalSchemaReferences

        public void setGenerateGlobalSchemaReferences​(boolean globalSchemaReferences)
        Description copied from interface: Generator
        Whether global schema references should be generated
        Specified by:
        setGenerateGlobalSchemaReferences in interface Generator
      • generateGlobalRoutineReferences

        public boolean generateGlobalRoutineReferences()
        Description copied from interface: Generator
        Whether global routine references should be generated
        Specified by:
        generateGlobalRoutineReferences in interface Generator
      • setGenerateGlobalRoutineReferences

        public void setGenerateGlobalRoutineReferences​(boolean generateGlobalRoutineReferences)
        Description copied from interface: Generator
        Whether global routine references should be generated
        Specified by:
        setGenerateGlobalRoutineReferences in interface Generator
      • generateGlobalSequenceReferences

        public boolean generateGlobalSequenceReferences()
        Description copied from interface: Generator
        Whether global sequence references should be generated
        Specified by:
        generateGlobalSequenceReferences in interface Generator
      • setGenerateGlobalSequenceReferences

        public void setGenerateGlobalSequenceReferences​(boolean generateGlobalSequenceReferences)
        Description copied from interface: Generator
        Whether global sequence references should be generated
        Specified by:
        setGenerateGlobalSequenceReferences in interface Generator
      • generateGlobalTableReferences

        public boolean generateGlobalTableReferences()
        Description copied from interface: Generator
        Whether global table references should be generated
        Specified by:
        generateGlobalTableReferences in interface Generator
      • setGenerateGlobalTableReferences

        public void setGenerateGlobalTableReferences​(boolean generateGlobalTableReferences)
        Description copied from interface: Generator
        Whether global table references should be generated
        Specified by:
        setGenerateGlobalTableReferences in interface Generator
      • generateGlobalDomainReferences

        public boolean generateGlobalDomainReferences()
        Description copied from interface: Generator
        Whether global domain references should be generated
        Specified by:
        generateGlobalDomainReferences in interface Generator
      • setGenerateGlobalDomainReferences

        public void setGenerateGlobalDomainReferences​(boolean globalDomainReferences)
        Description copied from interface: Generator
        Whether global domain references should be generated
        Specified by:
        setGenerateGlobalDomainReferences in interface Generator
      • generateGlobalUDTReferences

        public boolean generateGlobalUDTReferences()
        Description copied from interface: Generator
        Whether global UDT references should be generated
        Specified by:
        generateGlobalUDTReferences in interface Generator
      • setGenerateGlobalUDTReferences

        public void setGenerateGlobalUDTReferences​(boolean generateGlobalUDTReferences)
        Description copied from interface: Generator
        Whether global UDT references should be generated
        Specified by:
        setGenerateGlobalUDTReferences in interface Generator
      • generateGlobalQueueReferences

        public boolean generateGlobalQueueReferences()
        Description copied from interface: Generator
        Whether global queue references should be generated
        Specified by:
        generateGlobalQueueReferences in interface Generator
      • setGenerateGlobalQueueReferences

        public void setGenerateGlobalQueueReferences​(boolean globalQueueReferences)
        Description copied from interface: Generator
        Whether global queue references should be generated
        Specified by:
        setGenerateGlobalQueueReferences in interface Generator
      • generateGlobalLinkReferences

        public boolean generateGlobalLinkReferences()
        Description copied from interface: Generator
        Whether global link references should be generated
        Specified by:
        generateGlobalLinkReferences in interface Generator
      • setGenerateGlobalLinkReferences

        public void setGenerateGlobalLinkReferences​(boolean globalLinkReferences)
        Description copied from interface: Generator
        Whether global link references should be generated
        Specified by:
        setGenerateGlobalLinkReferences in interface Generator
      • generateGlobalKeyReferences

        public boolean generateGlobalKeyReferences()
        Description copied from interface: Generator
        Whether global key references should be generated
        Specified by:
        generateGlobalKeyReferences in interface Generator
      • setGenerateGlobalKeyReferences

        public void setGenerateGlobalKeyReferences​(boolean globalKeyReferences)
        Description copied from interface: Generator
        Whether global key references should be generated
        Specified by:
        setGenerateGlobalKeyReferences in interface Generator
      • generateGlobalIndexReferences

        public boolean generateGlobalIndexReferences()
        Description copied from interface: Generator
        Whether global index references should be generated
        Specified by:
        generateGlobalIndexReferences in interface Generator
      • setGenerateGlobalIndexReferences

        public void setGenerateGlobalIndexReferences​(boolean globalIndexReferences)
        Description copied from interface: Generator
        Whether global index references should be generated
        Specified by:
        setGenerateGlobalIndexReferences in interface Generator
      • generateQueues

        public boolean generateQueues()
        Description copied from interface: Generator
        Whether queue related code should be generated
        Specified by:
        generateQueues in interface Generator
      • setGenerateQueues

        public void setGenerateQueues​(boolean queues)
        Description copied from interface: Generator
        Whether queue related code should be generated
        Specified by:
        setGenerateQueues in interface Generator
      • generateLinks

        public boolean generateLinks()
        Description copied from interface: Generator
        Whether link related code should be generated
        Specified by:
        generateLinks in interface Generator
      • setGenerateLinks

        public void setGenerateLinks​(boolean links)
        Description copied from interface: Generator
        Whether link related code should be generated
        Specified by:
        setGenerateLinks in interface Generator
      • generateKeys

        public boolean generateKeys()
        Description copied from interface: Generator
        Whether key related code should be generated
        Specified by:
        generateKeys in interface Generator
      • setGenerateKeys

        public void setGenerateKeys​(boolean keys)
        Description copied from interface: Generator
        Whether key related code should be generated
        Specified by:
        setGenerateKeys in interface Generator
      • generateJavadoc

        public boolean generateJavadoc()
        Description copied from interface: Generator
        Whether any Javadoc should be generated.
        Specified by:
        generateJavadoc in interface Generator
      • setGenerateJavadoc

        public void setGenerateJavadoc​(boolean javadoc)
        Description copied from interface: Generator
        Whether any Javadoc should be generated.
        Specified by:
        setGenerateJavadoc in interface Generator
      • generateComments

        public boolean generateComments()
        Description copied from interface: Generator
        Whether any SQL comments should be generated as Javadoc.
        Specified by:
        generateComments in interface Generator
      • setGenerateComments

        public void setGenerateComments​(boolean comments)
        Description copied from interface: Generator
        Whether any SQL comments should be generated as Javadoc.
        Specified by:
        setGenerateComments in interface Generator
      • generateCommentsOnAttributes

        public boolean generateCommentsOnAttributes()
        Description copied from interface: Generator
        Whether SQL comments on attributes should be generated as Javadoc.
        Specified by:
        generateCommentsOnAttributes in interface Generator
      • setGenerateCommentsOnAttributes

        public void setGenerateCommentsOnAttributes​(boolean commentsOnAttributes)
        Description copied from interface: Generator
        Whether SQL comments on attributes should be generated as Javadoc.
        Specified by:
        setGenerateCommentsOnAttributes in interface Generator
      • generateCommentsOnCatalogs

        public boolean generateCommentsOnCatalogs()
        Description copied from interface: Generator
        Whether SQL comments on catalogs should be generated as Javadoc.
        Specified by:
        generateCommentsOnCatalogs in interface Generator
      • setGenerateCommentsOnCatalogs

        public void setGenerateCommentsOnCatalogs​(boolean commentsOnCatalogs)
        Description copied from interface: Generator
        Whether SQL comments on catalogs should be generated as Javadoc.
        Specified by:
        setGenerateCommentsOnCatalogs in interface Generator
      • generateCommentsOnColumns

        public boolean generateCommentsOnColumns()
        Description copied from interface: Generator
        Whether SQL comments on columns should be generated as Javadoc.
        Specified by:
        generateCommentsOnColumns in interface Generator
      • setGenerateCommentsOnColumns

        public void setGenerateCommentsOnColumns​(boolean commentsOnColumns)
        Description copied from interface: Generator
        Whether SQL comments on columns should be generated as Javadoc.
        Specified by:
        setGenerateCommentsOnColumns in interface Generator
      • generateCommentsOnKeys

        public boolean generateCommentsOnKeys()
        Description copied from interface: Generator
        Whether SQL comments on keys should be generated as Javadoc.
        Specified by:
        generateCommentsOnKeys in interface Generator
      • setGenerateCommentsOnKeys

        public void setGenerateCommentsOnKeys​(boolean commentsOnKeys)
        Description copied from interface: Generator
        Whether SQL comments on keys should be generated as Javadoc.
        Specified by:
        setGenerateCommentsOnKeys in interface Generator
      • generateCommentsOnLinks

        public boolean generateCommentsOnLinks()
        Description copied from interface: Generator
        Whether SQL comments on links should be generated as Javadoc.
        Specified by:
        generateCommentsOnLinks in interface Generator
      • setGenerateCommentsOnLinks

        public void setGenerateCommentsOnLinks​(boolean commentsOnLinks)
        Description copied from interface: Generator
        Whether SQL comments on links should be generated as Javadoc.
        Specified by:
        setGenerateCommentsOnLinks in interface Generator
      • generateCommentsOnPackages

        public boolean generateCommentsOnPackages()
        Description copied from interface: Generator
        Whether SQL comments on packages should be generated as Javadoc.
        Specified by:
        generateCommentsOnPackages in interface Generator
      • setGenerateCommentsOnPackages

        public void setGenerateCommentsOnPackages​(boolean commentsOnPackages)
        Description copied from interface: Generator
        Whether SQL comments on packages should be generated as Javadoc.
        Specified by:
        setGenerateCommentsOnPackages in interface Generator
      • generateCommentsOnParameters

        public boolean generateCommentsOnParameters()
        Description copied from interface: Generator
        Whether SQL comments on parameters should be generated as Javadoc.
        Specified by:
        generateCommentsOnParameters in interface Generator
      • setGenerateCommentsOnParameters

        public void setGenerateCommentsOnParameters​(boolean commentsOnParameters)
        Description copied from interface: Generator
        Whether SQL comments on parameters should be generated as Javadoc.
        Specified by:
        setGenerateCommentsOnParameters in interface Generator
      • generateCommentsOnQueues

        public boolean generateCommentsOnQueues()
        Description copied from interface: Generator
        Whether SQL comments on queues should be generated as Javadoc.
        Specified by:
        generateCommentsOnQueues in interface Generator
      • setGenerateCommentsOnQueues

        public void setGenerateCommentsOnQueues​(boolean commentsOnQueues)
        Description copied from interface: Generator
        Whether SQL comments on queues should be generated as Javadoc.
        Specified by:
        setGenerateCommentsOnQueues in interface Generator
      • generateCommentsOnRoutines

        public boolean generateCommentsOnRoutines()
        Description copied from interface: Generator
        Whether SQL comments on routines should be generated as Javadoc.
        Specified by:
        generateCommentsOnRoutines in interface Generator
      • setGenerateCommentsOnRoutines

        public void setGenerateCommentsOnRoutines​(boolean commentsOnRoutines)
        Description copied from interface: Generator
        Whether SQL comments on routines should be generated as Javadoc.
        Specified by:
        setGenerateCommentsOnRoutines in interface Generator
      • generateCommentsOnSchemas

        public boolean generateCommentsOnSchemas()
        Description copied from interface: Generator
        Whether SQL comments on schemas should be generated as Javadoc.
        Specified by:
        generateCommentsOnSchemas in interface Generator
      • setGenerateCommentsOnSchemas

        public void setGenerateCommentsOnSchemas​(boolean commentsOnSchemas)
        Description copied from interface: Generator
        Whether SQL comments on schemas should be generated as Javadoc.
        Specified by:
        setGenerateCommentsOnSchemas in interface Generator
      • generateCommentsOnSequences

        public boolean generateCommentsOnSequences()
        Description copied from interface: Generator
        Whether SQL comments on sequences should be generated as Javadoc.
        Specified by:
        generateCommentsOnSequences in interface Generator
      • setGenerateCommentsOnSequences

        public void setGenerateCommentsOnSequences​(boolean commentsOnSequences)
        Description copied from interface: Generator
        Whether SQL comments on sequences should be generated as Javadoc.
        Specified by:
        setGenerateCommentsOnSequences in interface Generator
      • generateCommentsOnTables

        public boolean generateCommentsOnTables()
        Description copied from interface: Generator
        Whether SQL comments on tables should be generated as Javadoc.
        Specified by:
        generateCommentsOnTables in interface Generator
      • setGenerateCommentsOnTables

        public void setGenerateCommentsOnTables​(boolean commentsOnTables)
        Description copied from interface: Generator
        Whether SQL comments on tables should be generated as Javadoc.
        Specified by:
        setGenerateCommentsOnTables in interface Generator
      • generateCommentsOnEmbeddables

        public boolean generateCommentsOnEmbeddables()
        Description copied from interface: Generator
        Whether SQL comments on embeddables should be generated as Javadoc.
        Specified by:
        generateCommentsOnEmbeddables in interface Generator
      • setGenerateCommentsOnEmbeddables

        public void setGenerateCommentsOnEmbeddables​(boolean generateCommentsOnEmbeddables)
        Description copied from interface: Generator
        Whether SQL comments on embeddables should be generated as Javadoc.
        Specified by:
        setGenerateCommentsOnEmbeddables in interface Generator
      • generateCommentsOnUDTs

        public boolean generateCommentsOnUDTs()
        Description copied from interface: Generator
        Whether SQL comments on UDTs should be generated as Javadoc.
        Specified by:
        generateCommentsOnUDTs in interface Generator
      • setGenerateCommentsOnUDTs

        public void setGenerateCommentsOnUDTs​(boolean commentsOnUDTs)
        Description copied from interface: Generator
        Whether SQL comments on UDTs should be generated as Javadoc.
        Specified by:
        setGenerateCommentsOnUDTs in interface Generator
      • generateSources

        public boolean generateSources()
        Description copied from interface: Generator
        Whether source code should be generated on any object type.
        Specified by:
        generateSources in interface Generator
      • setGenerateSources

        public void setGenerateSources​(boolean sources)
        Description copied from interface: Generator
        Whether source code should be generated on any object type.
        Specified by:
        setGenerateSources in interface Generator
      • generateSourcesOnViews

        public boolean generateSourcesOnViews()
        Description copied from interface: Generator
        Whether source code should be generated on views.
        Specified by:
        generateSourcesOnViews in interface Generator
      • setGenerateSourcesOnViews

        public void setGenerateSourcesOnViews​(boolean sourcesOnViews)
        Description copied from interface: Generator
        Whether source code should be generated on views.
        Specified by:
        setGenerateSourcesOnViews in interface Generator
      • fluentSetters

        @Deprecated
        public boolean fluentSetters()
        Deprecated.
        Description copied from interface: Generator
        Whether fluent setters should be generated
        Specified by:
        fluentSetters in interface Generator
      • setFluentSetters

        @Deprecated
        public void setFluentSetters​(boolean fluentSetters)
        Deprecated.
        Description copied from interface: Generator
        Whether fluent setters should be generated
        Specified by:
        setFluentSetters in interface Generator
      • generateFluentSetters

        public boolean generateFluentSetters()
        Description copied from interface: Generator
        Whether fluent setters should be generated
        Specified by:
        generateFluentSetters in interface Generator
      • setGenerateFluentSetters

        public void setGenerateFluentSetters​(boolean fluentSetters)
        Description copied from interface: Generator
        Whether fluent setters should be generated
        Specified by:
        setGenerateFluentSetters in interface Generator
      • generateJavaBeansGettersAndSetters

        public boolean generateJavaBeansGettersAndSetters()
        Description copied from interface: Generator
        Whether getters and setters should be generated JavaBeans style (or jOOQ style).
        Specified by:
        generateJavaBeansGettersAndSetters in interface Generator
      • setGenerateJavaBeansGettersAndSetters

        public void setGenerateJavaBeansGettersAndSetters​(boolean javaBeansGettersAndSetters)
        Description copied from interface: Generator
        Whether getters and setters should be generated JavaBeans style (or jOOQ style).
        Specified by:
        setGenerateJavaBeansGettersAndSetters in interface Generator
      • generateVarargsSetters

        public boolean generateVarargsSetters()
        Description copied from interface: Generator
        Whether varargs setters should be generated for array types.
        Specified by:
        generateVarargsSetters in interface Generator
      • setGenerateVarargsSetters

        public void setGenerateVarargsSetters​(boolean varargsSetters)
        Description copied from interface: Generator
        Whether varargs setters should be generated for array types.
        Specified by:
        setGenerateVarargsSetters in interface Generator
      • generatePojosEqualsAndHashCode

        public boolean generatePojosEqualsAndHashCode()
        Description copied from interface: Generator
        Whether equals() and hashCode() methods should be generated on POJOs
        Specified by:
        generatePojosEqualsAndHashCode in interface Generator
      • setGeneratePojosEqualsAndHashCode

        public void setGeneratePojosEqualsAndHashCode​(boolean generatePojosEqualsAndHashCode)
        Description copied from interface: Generator
        Whether equals() and hashCode() methods should be generated on POJOs
        Specified by:
        setGeneratePojosEqualsAndHashCode in interface Generator
      • generatePojosToString

        public boolean generatePojosToString()
        Description copied from interface: Generator
        Whether a toString() method should be generated on POJOs
        Specified by:
        generatePojosToString in interface Generator
      • setGeneratePojosToString

        public void setGeneratePojosToString​(boolean generatePojosToString)
        Description copied from interface: Generator
        Whether a toString() method should be generated on POJOs
        Specified by:
        setGeneratePojosToString in interface Generator
      • fullyQualifiedTypes

        @Deprecated
        public String fullyQualifiedTypes()
        Deprecated.
        Description copied from interface: Generator
        A regular expression matching all the types in generated code that should be fully qualified.
        Specified by:
        fullyQualifiedTypes in interface Generator
      • setFullyQualifiedTypes

        @Deprecated
        public void setFullyQualifiedTypes​(String fullyQualifiedTypes)
        Deprecated.
        Description copied from interface: Generator
        A regular expression matching all the types in generated code that should be fully qualified.
        Specified by:
        setFullyQualifiedTypes in interface Generator
      • generateFullyQualifiedTypes

        public String generateFullyQualifiedTypes()
        Description copied from interface: Generator
        A regular expression matching all the types in generated code that should be fully qualified.
        Specified by:
        generateFullyQualifiedTypes in interface Generator
      • setGenerateFullyQualifiedTypes

        public void setGenerateFullyQualifiedTypes​(String generateFullyQualifiedTypes)
        Description copied from interface: Generator
        A regular expression matching all the types in generated code that should be fully qualified.
        Specified by:
        setGenerateFullyQualifiedTypes in interface Generator
      • generateJavaTimeTypes

        public boolean generateJavaTimeTypes()
        Description copied from interface: Generator
        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+

        Specified by:
        generateJavaTimeTypes in interface Generator
      • setGenerateJavaTimeTypes

        public void setGenerateJavaTimeTypes​(boolean generateJavaTimeTypes)
        Description copied from interface: Generator
        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+

        Specified by:
        setGenerateJavaTimeTypes in interface Generator
      • generateEmptyCatalogs

        public boolean generateEmptyCatalogs()
        Description copied from interface: Generator
        Whether empty catalogs should still be generated.
        Specified by:
        generateEmptyCatalogs in interface Generator
      • setGenerateEmptyCatalogs

        public void setGenerateEmptyCatalogs​(boolean generateEmptyCatalogs)
        Description copied from interface: Generator
        Whether empty catalogs should still be generated.
        Specified by:
        setGenerateEmptyCatalogs in interface Generator
      • generateEmptySchemas

        public boolean generateEmptySchemas()
        Description copied from interface: Generator
        Whether empty schemas should still be generated.
        Specified by:
        generateEmptySchemas in interface Generator
      • setGenerateEmptySchemas

        public void setGenerateEmptySchemas​(boolean generateEmptySchemas)
        Description copied from interface: Generator
        Whether empty schemas should still be generated.
        Specified by:
        setGenerateEmptySchemas in interface Generator
      • generateNewline

        public String generateNewline()
        Description copied from interface: Generator
        The newline character(s) to be used in generated code.
        Specified by:
        generateNewline in interface Generator
      • setGenerateNewline

        public void setGenerateNewline​(String newline)
        Description copied from interface: Generator
        The newline character(s) to be used in generated code.
        Specified by:
        setGenerateNewline in interface Generator
      • generateIndentation

        public String generateIndentation()
        Description copied from interface: Generator
        The indentation character(s) to be used in generated code.
        Specified by:
        generateIndentation in interface Generator
      • setGenerateIndentation

        public void setGenerateIndentation​(String indentation)
        Description copied from interface: Generator
        The indentation character(s) to be used in generated code.
        Specified by:
        setGenerateIndentation in interface Generator
      • generatePrintMarginForBlockComment

        public int generatePrintMarginForBlockComment()
        Description copied from interface: Generator
        The print margin for Javadoc and other block comments to be used in generated code.
        Specified by:
        generatePrintMarginForBlockComment in interface Generator
      • setGeneratePrintMarginForBlockComment

        public void setGeneratePrintMarginForBlockComment​(int printMarginForBlockComment)
        Description copied from interface: Generator
        The print margin for Javadoc and other block comments to be used in generated code.
        Specified by:
        setGeneratePrintMarginForBlockComment in interface Generator
      • setTargetDirectory

        public void setTargetDirectory​(String directory)
        Description copied from interface: Generator
        Initialise the target directory
        Specified by:
        setTargetDirectory in interface Generator
      • setTargetPackage

        public void setTargetPackage​(String packageName)
        Description copied from interface: Generator
        Initialise the target package name
        Specified by:
        setTargetPackage in interface Generator
      • getTargetPackage

        public String getTargetPackage()
        Specified by:
        getTargetPackage in interface Generator
        Returns:
        Get the target package for the current configuration
      • setTargetEncoding

        public void setTargetEncoding​(String encoding)
        Description copied from interface: Generator
        Initialise the target encoding
        Specified by:
        setTargetEncoding in interface Generator
      • getTargetClean

        public boolean getTargetClean()
        Description copied from interface: Generator
        Whether the target package should be cleaned to contain only generated code after a generation run.
        Specified by:
        getTargetClean in interface Generator
      • setTargetClean

        public void setTargetClean​(boolean clean)
        Description copied from interface: Generator
        Whether the target package should be cleaned to contain only generated code after a generation run.
        Specified by:
        setTargetClean in interface Generator
      • empty

        protected void empty​(File file,
                             String suffix)
        If file is a directory, recursively empty its children. If file is a file, delete it.
      • empty

        protected void empty​(File file,
                             String suffix,
                             Set<File> keep,
                             Set<File> ignore)
        If file is a directory, recursively empty its children. If file is a file, delete it, except if it is in the list of files to keep.