001/*
002 * Copyright 2015-2022 Transmogrify LLC, 2022-2026 Revetware LLC.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package com.pyranid;
018
019import org.jspecify.annotations.NonNull;
020
021import java.sql.PreparedStatement;
022import java.sql.SQLException;
023
024/**
025 * Customizes a {@link PreparedStatement} before execution.
026 * <p>
027 * Used by {@link Query#customize(PreparedStatementCustomizer)}.
028 *
029 * @author <a href="https://www.revetkn.com">Mark Allen</a>
030 * @since 4.0.0
031 */
032@FunctionalInterface
033public interface PreparedStatementCustomizer {
034        /**
035         * Applies customization to the prepared statement before execution.
036         *
037         * @param statementContext  current SQL context
038         * @param preparedStatement the prepared statement to customize
039         * @throws SQLException if customization fails
040         */
041        void customize(@NonNull StatementContext<?> statementContext,
042                                                                 @NonNull PreparedStatement preparedStatement) throws SQLException;
043}