yosql-codegen/src/main/java/wtf/metio/yosql/codegen/files/MethodNameConfigurer.java

   1 /*
   2  * This file is part of yosql. It is subject to the license terms in the LICENSE file found in the top-level
   3  * directory of this distribution and at https://creativecommons.org/publicdomain/zero/1.0/. No part of yosql,
   4  * including this file, may be copied, modified, propagated, or distributed except according to the terms contained
   5  * in the LICENSE file.
   6  */
   7
   8 package wtf.metio.yosql.codegen.files;
   9
  10 import wtf.metio.yosql.models.immutables.SqlConfiguration;
  11
  12 /**
  13  * Handles the configuration of method names, e.g. the batch method prefix and suffix.
  14  *
  15  * @see DefaultSqlConfigurationFactory
  16  */
  17 @FunctionalInterface
  18 public interface MethodNameConfigurer {
  19
  20     /**
  21      * Configures method names and their affixes.
  22      *
  23      * @param configuration   The original configuration to adapt.
  24      * @param fileName        The file name where the SQL statement originated from.
  25      * @param statementInFile Which number of statement the given configuration represents in the source file.
  26      * @return An adapted version of the original.
  27      */
  28     SqlConfiguration configureNames(SqlConfiguration configuration, String fileName, int statementInFile);
  29
  30 }