org.jdbi.v3.sqlobject.internal.SqlAnnotations Maven / Gradle / Ivy

Go to download

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

SqlObject is a declarative, annotation-driven API for database access. It complements the core API. Jdbi 3 is designed to provide convenient tabular data access in Java(tm) and other JVM based languages. It uses the Java collections framework for query results, provides a convenient means of externalizing SQL statements, and named parameter support for any database that supports JDBC.

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.sqlobject.internal;

import java.lang.reflect.Method;
import java.util.Arrays;
import java.util.Optional;
import java.util.function.Function;
import java.util.stream.Collectors;

import org.jdbi.v3.core.internal.JdbiOptionals;
import org.jdbi.v3.core.internal.UtilityClassException;
import org.jdbi.v3.sqlobject.statement.SqlBatch;
import org.jdbi.v3.sqlobject.statement.SqlCall;
import org.jdbi.v3.sqlobject.statement.SqlQuery;
import org.jdbi.v3.sqlobject.statement.SqlScript;
import org.jdbi.v3.sqlobject.statement.SqlScripts;
import org.jdbi.v3.sqlobject.statement.SqlUpdate;

public class SqlAnnotations {
    private SqlAnnotations() {
        throw new UtilityClassException();
    }

    /**
     * Returns the value() of the @SqlBatch, @SqlCall, @SqlQuery,
     * @SqlUpdate, @SqlScripts, or @SqlScript annotation on the given method if declared and non-empty; empty otherwise.
     *
     * @param method the method
     * @return the annotation value()
     */
    public static Optional getAnnotationValue(Method method) {
        return getAnnotationValue(method, value -> value.isEmpty() ? null : value);
    }

    /**
     * Returns the value() of the @SqlBatch, @SqlCall, @SqlQuery,
     * @SqlUpdate, @SqlScripts, or @SqlScript annotation on the given method if declared; empty otherwise.
     *
     * Note: @SqlScripts values are mapped individually and concatenated with {@code " ; "}, hence the transformation parameter.
     *
     * @param method the method
     * @param transformation the String transformation (e.g. SQL lookup) to apply to the found value(s)
     * @return the annotation value()
     */
    public static Optional getAnnotationValue(Method method, Function transformation) {
        return JdbiOptionals.findFirstPresent(
            () -> Optional.ofNullable(method.getAnnotation(SqlBatch.class))
                .map(SqlBatch::value)
                .map(transformation),

            () -> Optional.ofNullable(method.getAnnotation(SqlCall.class))
                .map(SqlCall::value)
                .map(transformation),

            () -> Optional.ofNullable(method.getAnnotation(SqlQuery.class))
                .map(SqlQuery::value)
                .map(transformation),

            () -> Optional.ofNullable(method.getAnnotation(SqlUpdate.class))
                .map(SqlUpdate::value)
                .map(transformation),

            () -> Optional.ofNullable(method.getAnnotation(SqlScripts.class))
                .map(SqlScripts::value)
                .map(scripts -> Arrays.stream(scripts)
                    .map(SqlScript::value)
                    .map(transformation)
                    .collect(Collectors.joining(" ; "))),

            () -> Optional.ofNullable(method.getAnnotation(SqlScript.class))
                .map(SqlScript::value)
                .map(transformation)
        );
    }
}