io.spine.tools.gradle.bootstrap

Class Extension

java.lang.Object

io.spine.tools.gradle.bootstrap.Extension

public final class Extension
extends java.lang.Object

The spine Gradle DSL extension.

Configures the project as a Java or/and a JavaScript project based on Spine.

Method Summary

Modifier and Type	Method and Description
void	assembleModel() Marks this project as a project that contains the Protobuf model definition.
JavaExtension	enableJava() Marks this project as a Java project and configures the Java code generation.
void	enableJava(org.gradle.api.Action<JavaExtension> configuration) Marks this project as a Java project and configures the Java code generation.
void	enableJava(groovy.lang.Closure configuration) Marks this project as a Java project and configures the Java code generation.
JavaScriptExtension	enableJavaScript() Marks this project as a JavaScript project and configures the JavaScript code generation.
boolean	getForceDependencies() Returns true if the dependency enforcement is enabled for the current project.
void	setForceDependencies(boolean forceDependencies) Enables or disables the dependency enforcement for the current project.
java.lang.String	version() Obtains the version of the framework.

Methods inherited from class java.lang.Object

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

Method Detail

version

public java.lang.String version()

Obtains the version of the framework.

In a Gradle plugin, reference spine.version() in order to obtain the current Spine version.

Returns:

the currently used version of Spine as a string

enableJava

public void enableJava(groovy.lang.Closure configuration)

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

Parameters:

configuration - Groovy style configuration

See Also:

enableJava()

enableJava

public void enableJava(org.gradle.api.Action<JavaExtension> configuration)

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

Parameters:

configuration - Java/Kotlin style configuration

See Also:

enableJava()

enableJava

@CanIgnoreReturnValue
public JavaExtension enableJava()

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

Enables the Java code generation from Protobuf. If the spine-model-compiler plugin is not applied to this project, applies it immediately. Also adds the io.spine:spine-testlib

enableJavaScript

@CanIgnoreReturnValue
public JavaScriptExtension enableJavaScript()

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

Enables the JS code generation from Protobuf. If the spine-proto-js-plugin is not applied to this project, applies it immediately.

assembleModel

public void assembleModel()

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

Enables the protobuf and java plugins. Also adds the generated source sets.

getForceDependencies

public boolean getForceDependencies()

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

If the option is enabled, certain dependencies will be forced to resolve to the versions needed by the Spine Bootstrap plugin.

setForceDependencies

public void setForceDependencies(boolean forceDependencies)

Enables or disables the dependency enforcement for the current project.

In Spine Bootstrap plugin, for some elements, it's necessary to have the particular dependency no lower than version X in the project.

Set this field to true to ensure the "correct" dependency version is used regardless of project environment.

In Gradle build script may be used as follows:

     
     spine {
         forceDependencies = true
     }