org.jooq.api.annotation.Transition 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.api.annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.lang.reflect.Method;
/**
* Defines a "transition" in the state machine modelled by the DSL API.
*
* @author Lukas Eder
* @deprecated - 3.5.0 - [#3345] - The DSL API annotation is in a prototype
* state and will be removed from the 3.x APIs
*/
@Retention(RetentionPolicy.SOURCE)
@Target(ElementType.METHOD)
@Deprecated
public @interface Transition {
/**
* The Transition name.
*
* This describes the name of a transition in the state machine modelled by
* the DSL API. By default, the transition name matches the method name of
* the annotated method.
*/
String name() default "";
/**
* The Transition arguments.
*
* This describes the arguments of a transition in the state machine
* modelled by the DSL API.
*/
String[] args() default "";
/**
* The Transition source state.
*
* This describes the source state name of a transition in the state machine
* modelled by the DSL API. By default, the transition's source state name
* matches the state name of the declaring type of the annotated method:
*
* - If {@link #from()} is defined, that value is taken
* - Otherwise, if the annotated method's
* {@link Method#getDeclaringClass()} is annotated with {@link State}, that
* state's {@link State#name()} is taken
* - Otherwise, the {@link Method#getDeclaringClass()} class name is taken
*
*
*/
String from() default "";
/**
* The Transition target state.
*
* This describes the target state name of a transition in the state machine
* modelled by the DSL API. By default, the transition's target state name
* matches the state name of the return type of the annotated method:
*
* - If {@link #to()} is defined, that value is taken
* - Otherwise, if the annotated method's {@link Method#getReturnType()}
* is annotated with {@link State}, that state's {@link State#name()} is
* taken
* - Otherwise, the Method#getReturnType() class name is taken
*
*/
String to() default "";
}