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

import java.lang.annotation.Annotation;
import java.lang.reflect.Method;

import org.jdbi.v3.core.config.ConfigRegistry;

/**
 * Configures {@link ConfigRegistry} instances to satisfy the contract of a
 * {@link ConfiguringAnnotation}-annotated annotation.
 */
public interface Configurer {
    /**
     * Configures the registry for the given annotation on a sql object type.
     *
     * @param registry      the registry to configure
     * @param annotation    the annotation
     * @param sqlObjectType the sql object type which was annotated
     */
    default void configureForType(ConfigRegistry registry, Annotation annotation, Class sqlObjectType) {
        throw new UnsupportedOperationException("Not supported for type");
    }

    /**
     * Configures the registry for the given annotation on a sql object method.
     *
     * @param registry      the registry to configure
     * @param annotation    the annotation
     * @param sqlObjectType the sql object type
     * @param method        the method which was annotated
     */
    default void configureForMethod(ConfigRegistry registry, Annotation annotation, Class sqlObjectType, Method method) {
        throw new UnsupportedOperationException("Not supported for method");
    }
}