Available in versions: Dev (3.17) | Latest (3.16) | 3.15 | 3.14 | 3.13 | 3.12 | 3.11 | 3.10 | 3.9 | 3.8 | 3.7
Generated Interfaces
Applies to ✅ Open Source Edition ✅ Express Edition ✅ Professional Edition ✅ Enterprise Edition
Note, there are numerous problems related to generated interfaces as can be seen in #10509. A future version of jOOQ might remove support for this functionality.
Every table, view, udt in your database will generate an interface that looks like this:
public interface IBook extends java.io.Serializable {
// Every column generates a getter and a setter
public void setId(Integer value);
public Integer getId();
// [...]
}
The purpose of these interfaces is to be able to abstract over jOOQ generated records and POJOs.
Flags controlling interface generation
XML (standalone and maven)
Programmatic
Gradle
<configuration xmlns="http://www.jooq.org/xsd/jooq-codegen-3.9.2.xsd">
<generator>
<generate>
<!-- Turn on the generation of interfaces -->
<interfaces>true</interfaces>
<!-- Generated interfaces will not expose mutable components of their implementations, such as setters -->
<immutableInterfaces>true</immutableInterfaces>
</generate>
</generator>
</configuration>
new org.jooq.util.jaxb.Configuration()
.withGenerator(
new Generate()
// Turn on the generation of interfaces
.withInterfaces(true)
// Generated interfaces will not expose mutable components of their implementations, such as setters
.withImmutableInterfaces(true)
)
myConfigurationName(sourceSets.main) {
generator {
generate {
// Turn on the generation of interfaces
interfaces = true
// Generated interfaces will not expose mutable components of their implementations, such as setters
immutableInterfaces = true
}
}
}
Feedback
Do you have any feedback about this page? We'd love to hear it!