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 java.sql.PreparedStatement;
028import java.sql.SQLException;
029
030import com.ninja_squad.dbsetup.DbSetupTracker;
031
032/**
033 * An object which binds a value to a prepared statement parameter. It's advised to make implementations of this
034 * interface immutable, and to make them implement equals and hashCode in order for {@link DbSetupTracker} to function
035 * properly, or to make them singletons.
036 * @author JB Nizet
037 */
038public interface Binder {
039    /**
040     * Binds the given value to the given parameter in the given prepared statement.
041     * @param statement the statement to bind the parameter to
042     * @param param The index of the parameter to bind in the statement
043     * @param value The value to bind (may be <code>null</code>)
044     * @throws SQLException if the binding throws a {@link SQLException}
045     */
046    void bind(PreparedStatement statement, int param, Object value) throws SQLException;
047}