wtf.metio.yosql.codegen.api.StandardMethodGenerator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yosql-codegen-api Show documentation
The newest version!
/*
 * 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 http://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.api;

import com.squareup.javapoet.MethodSpec;
import wtf.metio.yosql.models.immutables.SqlConfiguration;
import wtf.metio.yosql.models.immutables.SqlStatement;

import java.util.List;

/**
 * Generates 'generic' methods - implementation decides whatever that means.
 */
public interface StandardMethodGenerator {

    /**
     * Generates code the execute a "generic" read against the database using the most common way the configured API
     * executes reads. The javax.sql package for example calls
     * {@link java.sql.PreparedStatement#executeQuery()}.
     *
     * @param configuration    The configuration for the generated method.
     * @param vendorStatements The vendor statements for the generated method.
     * @return A method specification for a generic reading method.
     */
    MethodSpec standardReadMethod(
            SqlConfiguration configuration,
            List vendorStatements);

    /**
     * Generates code the execute a "generic" write against the database using the most common way the configured API
     * executes writes. The javax.sql package for example calls
     * {@link java.sql.PreparedStatement#executeUpdate()}.
     *
     * @param configuration    The configuration for the generated method.
     * @param vendorStatements The vendor statements for the generated method.
     * @return A method specification for a generic writing method.
     */
    MethodSpec standardWriteMethod(
            SqlConfiguration configuration,
            List vendorStatements);

    /**
     * Generates code the execute a "generic" call against the database using the most common way the configured API
     * executes calls database functions. The javax.sql package for example calls
     * {@link java.sql.CallableStatement#executeQuery()}.
     *
     * @param configuration    The configuration for the generated method.
     * @param vendorStatements The vendor statements for the generated method.
     * @return A method specification for a generic calling method.
     */
    MethodSpec standardCallMethod(
            SqlConfiguration configuration,
            List vendorStatements);

}