io.spine.tools.gradle

Class CodeGenerationAction

java.lang.Object

io.spine.tools.gradle.CodeGenerationAction

All Implemented Interfaces:

io.spine.logging.Logging, org.gradle.api.Action<org.gradle.api.Task>

public abstract class CodeGenerationAction
extends java.lang.Object
implements org.gradle.api.Action<org.gradle.api.Task>, io.spine.logging.Logging

Abstract base for code generation actions.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CodeGenerationAction(org.gradle.api.Project project, java.util.function.Supplier<io.spine.code.proto.FileSet> files, java.util.function.Supplier<java.lang.String> targetDirPath, java.util.function.Supplier<java.lang.String> protoSrcDirPath) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
protected abstract io.spine.code.gen.Indent	getIndent(org.gradle.api.Project project) Obtains indentation configuration from the project.
protected io.spine.code.gen.Indent	indent() Obtains indentation to be used for code generation.
protected org.gradle.api.Project	project() Obtains the project for which the code is generated.
protected java.util.function.Supplier<io.spine.code.proto.FileSet>	protoFiles() Obtains the Protobuf files to be processed.
protected java.io.File	protoSrcDir() Obtains directory with source proto files.
protected java.io.File	targetDir() Obtains directory under which the generated source will be placed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.gradle.api.Action

execute

Methods inherited from interface io.spine.logging.Logging

_config, _debug, _error, _fine, _finer, _finest, _info, _severe, _trace, _warn, debugLevel, errorLevel, logger, loggerFor

Constructor Detail

CodeGenerationAction

protected CodeGenerationAction(org.gradle.api.Project project,
                               java.util.function.Supplier<io.spine.code.proto.FileSet> files,
                               java.util.function.Supplier<java.lang.String> targetDirPath,
                               java.util.function.Supplier<java.lang.String> protoSrcDirPath)

Creates a new instance.

Parameters:

project - the project for which we generated the code

files - the supplier of the Protobuf files, which (as other suppliers passed to the constructor) is dynamically evaluated when the task is executed

targetDirPath - the supplier of the path of the directory for the generated sources

protoSrcDirPath - the supplier of the path of the directory with .proto files

Method Detail

indent

protected final io.spine.code.gen.Indent indent()

Obtains indentation to be used for code generation.

getIndent

protected abstract io.spine.code.gen.Indent getIndent(org.gradle.api.Project project)

Obtains indentation configuration from the project.

project

protected final org.gradle.api.Project project()

Obtains the project for which the code is generated.

protoFiles

protected final java.util.function.Supplier<io.spine.code.proto.FileSet> protoFiles()

Obtains the Protobuf files to be processed.

protoSrcDir

protected final java.io.File protoSrcDir()

Obtains directory with source proto files.

targetDir

protected final java.io.File targetDir()

Obtains directory under which the generated source will be placed.