org.jdbi.v3.sqlobject.SqlObjects 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;

import java.util.Objects;

import org.jdbi.v3.core.config.JdbiConfig;
import org.jdbi.v3.sqlobject.customizer.SqlStatementCustomizerFactory;
import org.jdbi.v3.sqlobject.locator.AnnotationSqlLocator;
import org.jdbi.v3.sqlobject.locator.SqlLocator;
import org.jdbi.v3.sqlobject.statement.BindParameterCustomizerFactory;
import org.jdbi.v3.sqlobject.statement.ParameterCustomizerFactory;

/**
 * Configuration class for SQL objects.
 */
public class SqlObjects implements JdbiConfig {
    private SqlLocator sqlLocator;
    private ParameterCustomizerFactory defaultParameterCustomizerFactory;

    public SqlObjects() {
        sqlLocator = new AnnotationSqlLocator();
        defaultParameterCustomizerFactory = new BindParameterCustomizerFactory();
    }

    private SqlObjects(SqlObjects that) {
        sqlLocator = that.sqlLocator;
        defaultParameterCustomizerFactory = that.defaultParameterCustomizerFactory;
    }

    /**
     * Returns the configured {@link SqlLocator}. The default SQL locator is {@link AnnotationSqlLocator}.
     *
     * @return the configured {@link SqlLocator}.
     */
    public SqlLocator getSqlLocator() {
        return sqlLocator;
    }

    /**
     * Configures SqlObject to use the given {@link SqlLocator}.
     *
     * @param sqlLocator the new SQL locator.
     * @return this {@link SqlObjects}.
     */
    public SqlObjects setSqlLocator(SqlLocator sqlLocator) {
        this.sqlLocator = Objects.requireNonNull(sqlLocator);
        return this;
    }

    /**
     * Returns the configured {@link ParameterCustomizerFactory} used to bind sql statement parameters
     * when parameter is not explicitly annotated. By default it is configured as an instance of {@link BindParameterCustomizerFactory}.
     *
     * @return the configured {@link SqlStatementCustomizerFactory}.
     */
    public ParameterCustomizerFactory getDefaultParameterCustomizerFactory() {
        return defaultParameterCustomizerFactory;
    }

    /**
     * Configures SqlObject to use the given default parameter customizer factory.
     *
     * @param defaultParameterCustomizerFactory the new default parameter customizer factory.
     * @return this {@link SqlObjects}.
     */
    public SqlObjects setDefaultParameterCustomizerFactory(ParameterCustomizerFactory defaultParameterCustomizerFactory) {
        this.defaultParameterCustomizerFactory = defaultParameterCustomizerFactory;
        return this;
    }

    @Override
    public SqlObjects createCopy() {
        return new SqlObjects(this);
    }
}