A B C D E F G I J M N O P R S T U V W

A

apply(Project) - Method in class io.spine.tools.gradle.bootstrap.BootstrapPlugin

apply(GradlePlugin) - Method in class io.spine.tools.gradle.bootstrap.SpinePluginTarget

apply(PluginScript) - Method in class io.spine.tools.gradle.bootstrap.SpinePluginTarget

applyJavaPlugin() - Method in class io.spine.tools.gradle.bootstrap.SpinePluginTarget

Applies the standard JavaPlugin.

applyModelCompiler() - Method in class io.spine.tools.gradle.bootstrap.SpinePluginTarget

Applies the ModelCompilerPlugin.

applyProtobufPlugin() - Method in class io.spine.tools.gradle.bootstrap.SpinePluginTarget

Applies the ProtobufPlugin and the JavaPlugin.

applyProtoJsPlugin() - Method in class io.spine.tools.gradle.bootstrap.SpinePluginTarget

Applies the ProtoJsPlugin.

ArtifactSnapshot - Class in io.spine.tools.gradle.config

A snapshot of Spine-related dependencies which may be used in Spine-based projects.

ArtifactSnapshot.Builder - Class in io.spine.tools.gradle.config

A builder for the ArtifactsSnapshot instances.

assembleModel() - Method in class io.spine.tools.gradle.bootstrap.Extension

Marks this project as a project that contains the Protobuf model definition.

B

base() - Static method in class io.spine.tools.gradle.config.SpineDependency

Obtains a dependency on the io.spine:spine-base module.

BootstrapPlugin - Class in io.spine.tools.gradle.bootstrap

Spine Bootstrap plugin entrance point.

BootstrapPlugin() - Constructor for class io.spine.tools.gradle.bootstrap.BootstrapPlugin

build() - Method in class io.spine.tools.gradle.config.ArtifactSnapshot.Builder

Creates a new instance of ArtifactsSnapshot.

C

called(ProtocPlugin.Name) - Static method in class io.spine.tools.gradle.protoc.ProtocPlugin

client() - Method in class io.spine.tools.gradle.bootstrap.JavaExtension

Marks this project as a Java client of the system.

client() - Static method in class io.spine.tools.gradle.config.SpineDependency

Obtains a dependency on the io.spine:spine-client module.

codegen(Action<JavaCodegenExtension>) - Method in class io.spine.tools.gradle.bootstrap.JavaExtension

codegen(Closure) - Method in class io.spine.tools.gradle.bootstrap.JavaExtension

createIn(NamedDomainObjectContainer<GenerateProtoTask.PluginOptions>) - Method in class io.spine.tools.gradle.protoc.ProtocPlugin

D

disableBuiltIn(ProtocPlugin) - Method in class io.spine.tools.gradle.protoc.ProtobufGenerator

Disables code generation with the given protoc built-in.

disablePlugin(ProtocPlugin) - Method in class io.spine.tools.gradle.protoc.ProtobufGenerator

Disables code generation with the given protoc built-in.

E

enableBuiltIn(ProtocPlugin) - Method in class io.spine.tools.gradle.protoc.ProtobufGenerator

Enables code generation with the given protoc built-in.

enableJava(Closure) - Method in class io.spine.tools.gradle.bootstrap.Extension

Marks this project as a Java project and configures the Java code generation.

enableJava(Action<JavaExtension>) - Method in class io.spine.tools.gradle.bootstrap.Extension

Marks this project as a Java project and configures the Java code generation.

enableJava() - Method in class io.spine.tools.gradle.bootstrap.Extension

Marks this project as a Java project and configures the Java code generation.

enableJavaScript() - Method in class io.spine.tools.gradle.bootstrap.Extension

Marks this project as a JavaScript project and configures the JavaScript code generation.

enablePlugin(ProtocPlugin) - Method in class io.spine.tools.gradle.protoc.ProtobufGenerator

Enables code generation with the given protoc built-in.

Extension - Class in io.spine.tools.gradle.bootstrap

The spine Gradle DSL extension.

F

forcedDependencies() - Method in class io.spine.tools.gradle.bootstrap.JavaExtension

fromResources() - Static method in class io.spine.tools.gradle.config.ArtifactSnapshot

Loads the snapshot from the artifact-snapshot.properties resource of the plugin.

G

getCodegen() - Method in class io.spine.tools.gradle.bootstrap.JavaExtension

getForceDependencies() - Method in class io.spine.tools.gradle.bootstrap.Extension

Returns true if the dependency enforcement is enabled for the current project.

getGrpc() - Method in class io.spine.tools.gradle.bootstrap.JavaCodegenExtension

getProtobuf() - Method in class io.spine.tools.gradle.bootstrap.JavaCodegenExtension

getSpine() - Method in class io.spine.tools.gradle.bootstrap.JavaCodegenExtension

groupId() - Method in class io.spine.tools.gradle.config.SpineDependency

grpcDependencies() - Method in class io.spine.tools.gradle.config.ArtifactSnapshot

Obtains the artifacts required to generate and compile gRPC stubs successfully.

I

io.spine.tools.gradle.bootstrap - package io.spine.tools.gradle.bootstrap

This package contains the Spine bootstrap Gradle plugin.

io.spine.tools.gradle.config - package io.spine.tools.gradle.config

Contains classes which are responsible for the Gradle configuration and values.

io.spine.tools.gradle.protoc - package io.spine.tools.gradle.protoc

This package contains components configuring the Protobuf Gradle plugin.

isApplied(GradlePlugin) - Method in class io.spine.tools.gradle.bootstrap.SpinePluginTarget

J

JavaCodegenExtension - Class in io.spine.tools.gradle.bootstrap

A Gradle extension nested in JavaExtension which configures Java code generation.

JavaExtension - Class in io.spine.tools.gradle.bootstrap

An extension which configures Java code generation.

JavaScriptExtension - Class in io.spine.tools.gradle.bootstrap

An extension which configures JavaScript code generation.

M

ModelExtension - Class in io.spine.tools.gradle.bootstrap

An extension which declares a module as one that contains the Protobuf model definition.

N

name() - Method in class io.spine.tools.gradle.config.SpineDependency

newBuilder() - Static method in class io.spine.tools.gradle.config.ArtifactSnapshot

O

of(Project, Dependant, ArtifactSnapshot) - Static method in class io.spine.tools.gradle.bootstrap.JavaCodegenExtension

Creates a new instance of the extension.

P

ProtobufGenerator - Class in io.spine.tools.gradle.protoc

A facade for Protobuf plugin configuration.

ProtobufGenerator(Project) - Constructor for class io.spine.tools.gradle.protoc.ProtobufGenerator

protobufJava() - Method in class io.spine.tools.gradle.config.ArtifactSnapshot

Obtains the artifact spec for the core Protobuf Java library.

protoc() - Method in class io.spine.tools.gradle.config.ArtifactSnapshot

Obtains the artifact spec for the Protobuf compiler.

ProtocPlugin - Class in io.spine.tools.gradle.protoc

Protobuf compiler built-in which can be configured with the Spine plugin.

ProtocPlugin.Name - Enum in io.spine.tools.gradle.protoc

The enumeration of known protoc built-ins and plugins.

R

removeFrom(NamedDomainObjectContainer<GenerateProtoTask.PluginOptions>) - Method in class io.spine.tools.gradle.protoc.ProtocPlugin

S

server() - Method in class io.spine.tools.gradle.bootstrap.JavaExtension

Marks this project as a part of a Java server.

server() - Static method in class io.spine.tools.gradle.config.SpineDependency

Obtains a dependency on the io.spine:spine-server module.

setForceDependencies(boolean) - Method in class io.spine.tools.gradle.bootstrap.Extension

Enables or disables the dependency enforcement for the current project.

setGrpc(boolean) - Method in class io.spine.tools.gradle.bootstrap.JavaCodegenExtension

Enables or disables gRPC stub generation.

setGrpcProtobuf(String) - Method in class io.spine.tools.gradle.config.ArtifactSnapshot.Builder

setGrpcStub(String) - Method in class io.spine.tools.gradle.config.ArtifactSnapshot.Builder

setProtobuf(boolean) - Method in class io.spine.tools.gradle.bootstrap.JavaCodegenExtension

Enables or disables Protobuf to Java code generation.

setProtobufJava(String) - Method in class io.spine.tools.gradle.config.ArtifactSnapshot.Builder

setProtoc(String) - Method in class io.spine.tools.gradle.config.ArtifactSnapshot.Builder

setSpine(boolean) - Method in class io.spine.tools.gradle.bootstrap.JavaCodegenExtension

Enables or disables Spine-specific Java code generation.

setSpineRepository(String) - Method in class io.spine.tools.gradle.config.ArtifactSnapshot.Builder

setSpineSnapshotRepository(String) - Method in class io.spine.tools.gradle.config.ArtifactSnapshot.Builder

setSpineVersion(String) - Method in class io.spine.tools.gradle.config.ArtifactSnapshot.Builder

SpineDependency - Class in io.spine.tools.gradle.config

A Dependency on a Spine module.

SpinePluginTarget - Class in io.spine.tools.gradle.bootstrap

A PluginTarget which applies Spine Gradle plugins.

SpinePluginTarget(PluginTarget) - Constructor for class io.spine.tools.gradle.bootstrap.SpinePluginTarget

spineRepository() - Method in class io.spine.tools.gradle.config.ArtifactSnapshot

Obtains the Maven repository which hosts Spine artifacts with release versions.

spineSnapshotRepository() - Method in class io.spine.tools.gradle.config.ArtifactSnapshot

Obtains the Maven repository which hosts Spine artifacts with -SNAPSHOT versions.

spineVersion() - Method in class io.spine.tools.gradle.config.ArtifactSnapshot

Obtains the current version of Spine.

T

testlib() - Static method in class io.spine.tools.gradle.config.SpineDependency

Obtains a dependency on the io.spine:testlib module.

testUtilClient() - Static method in class io.spine.tools.gradle.config.SpineDependency

Obtains a dependency on the io.spine:testutil-client module.

testUtilServer() - Static method in class io.spine.tools.gradle.config.SpineDependency

Obtains a dependency on the io.spine:testutil-server module.

testUtilTime() - Static method in class io.spine.tools.gradle.config.SpineDependency

Obtains a dependency on the io.spine:testutil-time module.

time() - Static method in class io.spine.tools.gradle.config.SpineDependency

Obtains a dependency on the io.spine:spine-base module.

toString() - Method in class io.spine.tools.gradle.config.SpineDependency

U

useCompiler(String) - Method in class io.spine.tools.gradle.protoc.ProtobufGenerator

Specifies the Protobuf compiler to use to generate code.

V

valueOf(String) - Static method in enum io.spine.tools.gradle.protoc.ProtocPlugin.Name

Returns the enum constant of this type with the specified name.

values() - Static method in enum io.spine.tools.gradle.protoc.ProtocPlugin.Name

Returns an array containing the constants of this enum type, in the order they are declared.

version() - Method in class io.spine.tools.gradle.bootstrap.Extension

Obtains the version of the framework.

W

withOption(ProtocPlugin.Name, String) - Static method in class io.spine.tools.gradle.protoc.ProtocPlugin

A B C D E F G I J M N O P R S T U V W