org.jdbi.v3.stringtemplate4.UseStringTemplateSqlLocator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jdbi3-stringtemplate4 Show documentation

Use Stringtemplate 4 for query templating.

There is a newer version: 3.47.0

Show newest version

/*
 * 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.stringtemplate4;

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.extension.annotation.UseExtensionConfigurer;
import org.jdbi.v3.stringtemplate4.internal.UseStringTemplateSqlLocatorImpl;

/**
 * Configures SQL Object to locate SQL using the {@link StringTemplateSqlLocator#findStringTemplate(Class, String)}
 * method. If the SQL annotation (e.g. @SqlQuery) defines a value (e.g. @SqlQuery("hello")),
 * that value ("hello") will be used for the name parameter; if undefined, the name of the SQL
 * object method will be used:
 *
 *  *     @UseStringTemplateSqlLocator
 *     interface Viccini {
 *         @SqlUpdate
 *         void doTheThing(long id);     // => StringTemplateSqlLocator.findStringTemplateSql(Viccini.class, "doTheThing")
 *
 *         @SqlUpdate("thatOtherThing")
 *         void doTheThing(String name); // => StringTemplateSqlLocator.findStringTemplateSql(Viccini.class, "thatOtherThing")
 *     }
 * 
 */
@UseExtensionConfigurer(UseStringTemplateSqlLocatorImpl.class)
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD})
public @interface UseStringTemplateSqlLocator {}