The jOOQ User Manual : Code generation : Advanced generator configuration : Generate : Annotations

previous : next

Annotations

Applies to ✅ Open Source Edition   ✅ Express Edition   ✅ Professional Edition   ✅ Enterprise Edition

The code generator supports a set of annotations on generated code, which can be turned on using the following flags. These annotations include:

• Generated annotations: The JDK generated annotation can be added to all generated classes to include some useful meta information, like the jOOQ version, or the schema version, or the generation date:
  • javax.annotation.processing.Generated (JDK 9+, upgrade to jOOQ 3.12+ to profit from this)
  • javax.annotation.Generated (JDK 8-)
• JPA annotations: A minimal set of JPA annotations can be generated on POJOs and other artefacts to convey type and metadata information that is available to the code generator. These annotations include:
  • javax.persistence.Column
  • javax.persistence.Entity
  • javax.persistence.GeneratedValue
  • javax.persistence.GenerationType
  • javax.persistence.Id
  • javax.persistence.Table
  • javax.persistence.UniqueConstraint
  While jOOQ generated code cannot really be used as full-fledged entities (use e.g. Hibernate or EclipseLink to generate such entities), this meta information can still be useful as documentation on your generated code. Some of the annotations (e.g. @Column) can be used by the org.jooq.impl.DefaultRecordMapper for mapping records to POJOs.
• Validation annotations: A set of Bean Validation API annotations can be added to the generated code to convey type information. They include:
  • javax.validation.constraints.NotNull
  • javax.validation.constraints.Size
  jOOQ does not implement the validation spec, nor does it validate your data, but you can use third-party tools to read the jOOQ-generated validation annotations.
• Spring annotations: Some useful Spring annotations can be generated on DAOs for better Spring integration. These include:
  • org.springframework.beans.factory.annotation.Autowired
  • org.springframework.stereotype.Repository

The flags governing the generation of these annotations are:

<configuration xmlns="http://www.jooq.org/xsd/jooq-codegen-3.9.2.xsd">
  <generator>
    <generate>
      <generatedAnnotation>true</generatedAnnotation>
      <jpaAnnotations>true</jpaAnnotations>
      <validationAnnotations>true</validationAnnotations>
      <springAnnotations>true</springAnnotations>
    </generate>
  </generator>
</configuration>

new org.jooq.util.jaxb.Configuration()
  .withGenerator(
    new Generate()
      .withGeneratedAnnotation(true)
      .withJpaAnnotations(true)
      .withValidationAnnotations(true)
      .withSpringAnnotations(true)
  )

myConfigurationName(sourceSets.main) {
  generator {
    generate {
      generatedAnnotation = true
      jpaAnnotations = true
      validationAnnotations = true
      springAnnotations = true
    }
  }
}

The jOOQ User Manual : Code generation : Advanced generator configuration : Generate : Annotations

previous : next