wtf.metio.yosql.codegen.blocks.CodeBlocks 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.blocks;

import com.squareup.javapoet.CodeBlock;
import wtf.metio.yosql.models.configuration.ResultRowConverter;

/**
 * Utility class for {@link CodeBlock} related code.
 */
public interface CodeBlocks {

    /**
     * Creates a new {@link CodeBlock} based on the provided String and arguments.
     *
     * @param format The code template to use.
     * @param args   The template arguments to apply.
     * @return A new {@link CodeBlock} representing the resulting code.
     */
    static CodeBlock code(final String format, final Object... args) {
        return CodeBlock.builder().add(format, args).build();
    }

    CodeBlock returnTrue();

    CodeBlock returnFalse();

    CodeBlock close(String resource);

    CodeBlock initializeFieldToSelf(String fieldName);

    CodeBlock returnValue(CodeBlock value);

    CodeBlock initializeConverter(ResultRowConverter converter);

}