001/*
002 * The MIT License
003 *
004 * Copyright (c) 2012, Ninja Squad
005 *
006 * Permission is hereby granted, free of charge, to any person obtaining a copy
007 * of this software and associated documentation files (the "Software"), to deal
008 * in the Software without restriction, including without limitation the rights
009 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
010 * copies of the Software, and to permit persons to whom the Software is
011 * furnished to do so, subject to the following conditions:
012 *
013 * The above copyright notice and this permission notice shall be included in
014 * all copies or substantial portions of the Software.
015 *
016 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
017 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
018 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
019 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
020 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
021 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
022 * THE SOFTWARE.
023 */
024
025package com.ninja_squad.dbsetup.bind;
026
027import com.ninja_squad.dbsetup.DbSetup;
028import com.ninja_squad.dbsetup.DbSetupTracker;
029
030import javax.annotation.Nullable;
031import java.sql.ParameterMetaData;
032import java.sql.SQLException;
033
034/**
035 * An object which returns the appropriate {@link Binder} based on the metadata of the prepared statement.
036 * The default instance of this interface is {@link DefaultBinderConfiguration}. If the binders returned by this
037 * default configuration don't fit for the particular database you're using, or if you would like the binders
038 * returned by the configuration to support additional data types, you might want to provide a different implementation
039 * of this interface to the {@link DbSetup}.
040 * <p>
041 * It's advised to make implementations of this interface immutable, and to make them implement equals and hashCode
042 * in order for {@link DbSetupTracker} to function properly, or to make them singletons.
043 * @author JB Nizet
044 */
045public interface BinderConfiguration {
046
047    /**
048     * Returns the appropriate {@link Binder} for the given parameter, based on the given metadata.
049     * @param metadata the metadata allowing to decide which Binder to return. <code>null</code> if the Insert has been
050     * configured to not use metadata, or if the JDBC driver returned null metadata, or the JDBC driver threw a
051     * SQLException when asked for the metadata
052     * @param param the param for which a binder is requested
053     * @return the binder for the given param and its metadata
054     * @throws SQLException if a SQLException occurs while using the metadata
055     */
056    Binder getBinder(@Nullable ParameterMetaData metadata, int param) throws SQLException;
057}