wtf.metio.yosql.codegen.dao.ReadMethodGenerator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of yosql-codegen Show documentation

There is a newer version: 2023.5.3

/*
 * 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.dao;

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

import java.util.List;

/**
 * Generates READING methods.
 */
public interface ReadMethodGenerator {

    /**
     * Method declaration for a method that executes a read against a database.
     *
     * @param configuration    The configuration for the generated method.
     * @param vendorStatements The vendor statements for the generated method.
     * @return A method declaration for a reading method.
     */
    MethodSpec readMethodDeclaration(
            SqlConfiguration configuration,
            List vendorStatements);

    /**
     * Generates code that executes a read against a database.
     *
     * @param configuration    The configuration for the generated method.
     * @param vendorStatements The vendor statements for the generated method.
     * @return A method specification for a reading method.
     */
    MethodSpec readMethod(
            SqlConfiguration configuration,
            List vendorStatements);

}