Available in versions: Dev (3.21) | Latest (3.20) | 3.19 | 3.18 | 3.17 | 3.16 | 3.15 | 3.14 | 3.13 | 3.12 | 3.11
Enum converters
Applies to ✅ Open Source Edition ✅ Express Edition ✅ Professional Edition ✅ Enterprise Edition
If your user type is a Java enum, you can use the <enumConverter/> convenience flag instead of an explicit converter per enum type. This will apply the built-in org.jooq.impl.EnumConverter.
<configuration>
<generator>
<database>
<forcedTypes>
<forcedType>
<!-- Specify the Java type of your custom type. This corresponds to the Converter's <U> type. -->
<userType>com.example.MyEnum</userType>
<!-- Apply the built in org.jooq.impl.EnumConverter. -->
<enumConverter>true</enumConverter>
<!-- A Java regex matching fully-qualified columns, attributes, parameters. Use the pipe to separate several expressions. -->
<includeExpression>.*\.MY_STATUS</includeExpression>
</forcedType>
</forcedTypes>
</database>
</generator>
</configuration>
See the configuration XSD, standalone code generation, and maven code generation for more details.
new org.jooq.meta.jaxb.Configuration()
.withGenerator(new Generator()
.withDatabase(new Database()
.withForcedTypes(
new ForcedType()
// Specify the Java type of your custom type. This corresponds to the Converter's <U> type.
.withUserType("com.example.MyEnum")
// Apply the built in org.jooq.impl.EnumConverter.
.withEnumConverter(true)
// A Java regex matching fully-qualified columns, attributes, parameters. Use the pipe to separate several expressions.
.withIncludeExpression(".*\\.MY_STATUS")
)
)
)
See the configuration XSD and programmatic code generation for more details.
// The jOOQ-codegen-gradle plugin has been introduced in version 3.19 only.
// The jOOQ-codegen-gradle plugin has been introduced in version 3.19 only.
generationTool {
generator {
database {
forcedTypes {
forcedType {
// Specify the Java type of your custom type. This corresponds to the Converter's <U> type.
userType = "com.example.MyEnum"
// Apply the built in org.jooq.impl.EnumConverter.
enumConverter = true
// A Java regex matching fully-qualified columns, attributes, parameters. Use the pipe to separate several expressions.
includeExpression = ".*\\.MY_STATUS"
}
}
}
}
}
See the configuration XSD and gradle code generation for more details.
As always, when regular expressions are used, they are regular expressions with default flags.
The effect on your query user code will be the same as with explicit converters.
For more details about how to match columns, please refer to the section about matching columns for forced types.
Feedback
Do you have any feedback about this page? We'd love to hear it!