wtf.metio.yosql.codegen.files.MethodNameConfigurer Maven / Gradle / Ivy

Go to download
/*
 * This file is part of yosql. It is subject to the license terms in the LICENSE file found in the top-level
 * directory of this distribution and at https://creativecommons.org/publicdomain/zero/1.0/. No part of yosql,
 * including this file, may be copied, modified, propagated, or distributed except according to the terms contained
 * in the LICENSE file.
 */

package wtf.metio.yosql.codegen.files;

import wtf.metio.yosql.models.immutables.SqlConfiguration;

/**
 * Handles the configuration of method names, e.g. the batch method prefix and suffix.
 *
 * @see DefaultSqlConfigurationFactory
 */
@FunctionalInterface
public interface MethodNameConfigurer {

    /**
     * Configures method names and their affixes.
     *
     * @param configuration   The original configuration to adapt.
     * @param fileName        The file name where the SQL statement originated from.
     * @param statementInFile Which number of statement the given configuration represents in the source file.
     * @return An adapted version of the original.
     */
    SqlConfiguration configureNames(SqlConfiguration configuration, String fileName, int statementInFile);

}