org.jooq.EnumType Maven / Gradle / Ivy
/*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* Other licenses:
* -----------------------------------------------------------------------------
* Commercial licenses for this work are available. These replace the above
* ASL 2.0 and offer limited warranties, support, maintenance, and commercial
* database integrations.
*
* For more information, please visit: http://www.jooq.org/licenses
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*/
package org.jooq;
/**
* A SQL enum type. This can be any of the following:
*
* - In {@link SQLDialect#MARIADB}, this can be a column-scope enum type
* - In {@link SQLDialect#MYSQL}, this can be a column-scope enum type
* - In {@link 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
* {@link Enum}. In Scala, for instance, enums are not idiomatic, and jOOQ
* implements them differently. In any case, this {@link EnumType} API is
* implemented by generated database enums.
*
* @author Lukas Eder
*/
public interface EnumType {
/**
* The literal as defined in the database
*/
String getLiteral();
/**
* The catalog of the enum type, if applicable. Otherwise, this returns
* null
*/
Catalog getCatalog();
/**
* The schema of the enum type, if applicable (Postgres schema-scope enum
* type only). Otherwise, this returns null
*/
Schema getSchema();
/**
* The type name as registered in the database, if applicable (Postgres
* schema-scope enum type only). Otherwise, this returns null
*/
String getName();
}