-
public interface EnumType
A SQL enum type. This can be any of the following:- In
SQLDialect.MARIADB
, this can be a column-scope enum type - In
SQLDialect.MYSQL
, this can be a column-scope enum type - In
SQLDialect.POSTGRES
, this can be a schema-scope enum type - In all other dialects, this can be an enum type as defined in the code generation configuration [#968]
Client code should not assume that the actual enum reference is a Java
Enum
. In Scala, for instance, enums are not idiomatic, and jOOQ implements them differently. In any case, thisEnumType
API is implemented by generated database enums.- Author:
- Lukas Eder
- In
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default @Nullable Catalog
getCatalog()
The catalog of the enum type, if applicable.@NotNull String
getLiteral()
The literal as defined in the database@Nullable String
getName()
The type name as registered in the database, if applicable (Postgres schema-scope enum type only).default @Nullable Schema
getSchema()
The schema of the enum type, if applicable (Postgres schema-scope enum type only).
-
-
-
Method Detail
-
getLiteral
@NotNull @NotNull String getLiteral()
The literal as defined in the database
-
getCatalog
@Nullable default @Nullable Catalog getCatalog()
The catalog of the enum type, if applicable. Otherwise, this returnsnull
-
getSchema
@Nullable default @Nullable Schema getSchema()
The schema of the enum type, if applicable (Postgres schema-scope enum type only). Otherwise, this returnsnull
-
getName
@Nullable @Nullable String getName()
The type name as registered in the database, if applicable (Postgres schema-scope enum type only). Otherwise, this returnsnull
-
-