org.jdbi.v3.stringtemplate3.UseStringTemplateStatementRewriter Maven / Gradle / Ivy

Go to download

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

jdbi-string-template locates SQL statements in StringTemplate files on the classpath

There is a newer version: 3.0.0-alpha7

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.stringtemplate3;

import java.lang.annotation.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.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.function.Consumer;

import org.jdbi.v3.core.config.ConfigRegistry;
import org.jdbi.v3.core.statement.SqlStatements;
import org.jdbi.v3.core.rewriter.ColonPrefixStatementRewriter;
import org.jdbi.v3.core.rewriter.StatementRewriter;
import org.jdbi.v3.sqlobject.config.ConfigurerFactory;
import org.jdbi.v3.sqlobject.config.ConfiguringAnnotation;
import org.jdbi.v3.sqlobject.customizer.Define;

/**
 * Configures a SQL object class or method to rewrite SQL statements using StringTemplate. Method parameters annotated
 * with {@link Define @Define} are passed to the StringTemplate as template
 * attributes.
 */
@ConfiguringAnnotation(UseStringTemplateStatementRewriter.Factory.class)
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface UseStringTemplateStatementRewriter {
    Class value() default ColonPrefixStatementRewriter.class;

    class Factory implements ConfigurerFactory {
        @Override
        public Consumer createForType(Annotation annotation, Class sqlObjectType) {
            return create((UseStringTemplateStatementRewriter) annotation);
        }

        @Override
        public Consumer createForMethod(Annotation annotation, Class sqlObjectType, Method method) {
            return create((UseStringTemplateStatementRewriter) annotation);
        }

        private Consumer create(UseStringTemplateStatementRewriter annotation) {
            StatementRewriter delegate = createDelegate(annotation.value());
            StatementRewriter rewriter = new StringTemplateStatementRewriter(delegate);
            return config -> config.get(SqlStatements.class).setStatementRewriter(rewriter);
        }

        private StatementRewriter createDelegate(Class type) {
            try {
                return type.getConstructor().newInstance();
            } catch (InstantiationException | IllegalAccessException | InvocationTargetException | NoSuchMethodException e) {
                throw new IllegalStateException("Error instantiating delegate statement rewriter: " + type, e);
            }
        }
    }
}