org.jooq.Support Maven / Gradle / Ivy
/**
* Copyright (c) 2009-2014, Data Geekery GmbH (http://www.datageekery.com)
* All rights reserved.
*
* This work is dual-licensed
* - under the Apache Software License 2.0 (the "ASL")
* - under the jOOQ License and Maintenance Agreement (the "jOOQ License")
* =============================================================================
* You may choose which license applies to you:
*
* - If you're using this work with Open Source databases, you may choose
* either ASL or jOOQ License.
* - If you're using this work with at least one commercial database, you must
* choose jOOQ License
*
* For more information, please visit http://www.jooq.org/licenses
*
* Apache Software License 2.0:
* -----------------------------------------------------------------------------
* 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.
*
* jOOQ License and Maintenance Agreement:
* -----------------------------------------------------------------------------
* Data Geekery grants the Customer the non-exclusive, timely limited and
* non-transferable license to install and use the Software under the terms of
* the jOOQ License and Maintenance Agreement.
*
* This library is distributed with a LIMITED WARRANTY. See the jOOQ License
* and Maintenance Agreement for more details: http://www.jooq.org/licensing
*/
package org.jooq;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import org.jooq.exception.SQLDialectNotSupportedException;
/**
* A formal declaration of whether any API element is supported by a given
* {@link SQLDialect}
*
* The annotation is mainly used in three modes:
*
* - The annotation is absent on a method. This means that the applied
*
SQLDialect is irrelevant for that method. This is mostly the
* case for jOOQ's general API (creating factories, rendering SQL, binding
* variables, etc.) as well as utility methods.
* - The annotation is present but "empty" on a method, i.e. it specifies no
*
SQLDialect. This means that all of jOOQ's dialects are supported
* by this API method. This is typically the case with jOOQ's SQL construction
* API for very common clauses, such as the creation of SELECT,
* UPDATE, INSERT, DELETE.
* - The annotation is present and specifies one or more dialects. A method
* annotated in such a way should be used only along with any of the dialects
* specified by the annotation. This is typically the case with jOOQ's SQL
* construction API for less common clauses, such as the creation of
*
MERGE, etc.
*
*
* Future versions of jOOQ may use these annotations for throwing
* {@link SQLDialectNotSupportedException} where appropriate, or preprocessing
* jOOQ source code in order to mark unsupported API as {@link Deprecated}
*
* @author Lukas Eder
*/
@Target({ElementType.METHOD, ElementType.FIELD})
@Retention(RUNTIME)
@Documented
public @interface Support {
/**
* A {@link SQLDialect} array containing all dialects that are supported by
* the API method annotated with this annotation.
*/
SQLDialect[] value() default {};
}