io.spine.tools.gradle

Class ProtoPlugin

java.lang.Object

io.spine.tools.gradle.SpinePlugin

io.spine.tools.gradle.ProtoPlugin

All Implemented Interfaces:

io.spine.logging.Logging, org.gradle.api.Plugin<org.gradle.api.Project>

public abstract class ProtoPlugin
extends SpinePlugin

A plugin performing code-generation based on a .proto files.

Implementation Note:

This class uses Suppliers instead of direct values because at the time of creation Gradle project is not fully evaluated, and the values are not yet defined.

Constructor Summary

Constructors

Constructor and Description
ProtoPlugin()

Method Summary

Modifier and Type	Method and Description
protected abstract java.util.function.Supplier<java.io.File>	mainDescriptorFile(org.gradle.api.Project project) Obtains the descriptor set file for the main scope.
protected java.util.function.Supplier<io.spine.code.proto.FileSet>	mainProtoFiles(org.gradle.api.Project project) Obtains Protobuf files for the main scope.
protected abstract java.util.function.Supplier<java.io.File>	testDescriptorFile(org.gradle.api.Project project) Obtains the descriptor set file for the test scope.
protected java.util.function.Supplier<io.spine.code.proto.FileSet>	testProtoFiles(org.gradle.api.Project project) Obtains Protobuf files for the test scope.

Methods inherited from class io.spine.tools.gradle.SpinePlugin

logMissingDescriptorSetFile, newTask, resolve

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.Plugin

apply

Methods inherited from interface io.spine.logging.Logging

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

Constructor Detail

ProtoPlugin

public ProtoPlugin()

Method Detail

mainProtoFiles

protected final java.util.function.Supplier<io.spine.code.proto.FileSet> mainProtoFiles(org.gradle.api.Project project)

Obtains Protobuf files for the main scope.

testProtoFiles

protected final java.util.function.Supplier<io.spine.code.proto.FileSet> testProtoFiles(org.gradle.api.Project project)

Obtains Protobuf files for the test scope.

mainDescriptorFile

protected abstract java.util.function.Supplier<java.io.File> mainDescriptorFile(org.gradle.api.Project project)

Obtains the descriptor set file for the main scope.

testDescriptorFile

protected abstract java.util.function.Supplier<java.io.File> testDescriptorFile(org.gradle.api.Project project)

Obtains the descriptor set file for the test scope.