/*
 * 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.
 */
package org.jdbi.v3.sqlobject.customizer;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.jdbi.v3.core.statement.StatementContext;
import org.jdbi.v3.sqlobject.customizer.internal.DefineFactory;

Defines a named attribute as the argument passed to the annotated parameter. Attributes are stored on the StatementContext, and may be used by statement customizers such as the template engine. /**
 * Defines a named attribute as the argument passed to the annotated parameter.
 * Attributes are stored on the {@link StatementContext}, and may be used by
 * statement customizers such as the template engine.
 */
@SqlStatementCustomizingAnnotation(DefineFactory.class)
@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
public @interface Define {
    
The attribute name to define. If omitted, the name of the annotated parameter is used. It is an error to omit
the name when there is no parameter naming information in your class files.
Returns:
the attribute name./**
     * The attribute name to define. If omitted, the name of the annotated parameter is used. It is an error to omit
     * the name when there is no parameter naming information in your class files.
     *
     * @return the attribute name.
     */
    String value() default "";
}