io.spine.tools.gradle

Class GradleTask.Builder

java.lang.Object

io.spine.tools.gradle.GradleTask.Builder

Enclosing class:

GradleTask

public static final class GradleTask.Builder
extends java.lang.Object

A builder for GradleTask.

NOTE: unlike most classes following the Builder pattern, this one provides applyNowTo(Project) method instead of build(..). This is done to add some additional semantics to such an irreversible action like this.

Method Summary

Modifier and Type	Method and Description
GradleTask.Builder	allowNoDependencies() States that the task dependencies will be added to the task later.
GradleTask	applyNowTo(org.gradle.api.Project project) Builds an instance of GradleTask and inserts it to the project build lifecycle according to the "before" and "after" tasks specified in the builder.
GradleTask.Builder	insertAfterAllTasks(TaskName target) Inserts tasks which will precede the new one.
GradleTask.Builder	insertAfterTask(TaskName target) Specify a task which will precede the new one.
GradleTask.Builder	insertBeforeTask(TaskName target) Specify a task which will follow the new one.
GradleTask.Builder	withInputFiles(org.gradle.api.file.FileCollection inputs) Adds the files and/or directories to the input file set for the task being built.
GradleTask.Builder	withInputProperty(java.lang.String propertyName, @Nullable java.io.Serializable value) Adds a task input property.
GradleTask.Builder	withOutputFiles(org.gradle.api.file.FileCollection outputs) Adds the files and/or directories to the output file set for the task being built.

Methods inherited from class java.lang.Object

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

Method Detail

insertBeforeTask

public GradleTask.Builder insertBeforeTask(TaskName target)

Specify a task which will follow the new one.

Once built, the new instance of GradleTask will be inserted before the anchor.

NOTE: invocation of either this method or insertAfterTask(io.spine.tools.gradle.TaskName) is mandatory, as the newly created instance of GradleTask must be put to a certain place in the Gradle build lifecycle.

Parameters:

target - the name of the task, serving as "before" anchor

Returns:

the current instance of Builder

insertAfterTask

public GradleTask.Builder insertAfterTask(TaskName target)

Specify a task which will precede the new one.

Once built, the new instance of GradleTask will be inserted after the anchor.

NOTE: invocation of either this method or insertBeforeTask(io.spine.tools.gradle.TaskName) is mandatory, as the newly created instance of GradleTask must be put to a certain place in the Gradle build lifecycle.

Parameters:

target - the name of the task, serving as "after" anchor

Returns:

the current instance of Builder

insertAfterAllTasks

public GradleTask.Builder insertAfterAllTasks(TaskName target)

Inserts tasks which will precede the new one.

Unlike insertAfterTask(), this method will depend the new task on every task with such name in the project (i.e. the tasks of the root project and all the subprojects).

If a certain project does not have a task with the specified name, no action is performed for that project.

This method does not guarantee that the task will be included into a standard Gradle build.

Invocation of this method may substitute the invocation of insertAfterTask(io.spine.tools.gradle.TaskName) or insertBeforeTask(io.spine.tools.gradle.TaskName) if it's guaranteed that at least one task with such name exists. Though the fallback is never handled and there is no guarantee that the task will get into the Gradle task graph.

Parameters:

target - the name of the tasks, serving as "after" anchor

Returns:

the current instance of Builder

allowNoDependencies

public GradleTask.Builder allowNoDependencies()

States that the task dependencies will be added to the task later.

If this method is not called, the dependencies must be specified via this builder.

withInputFiles

public GradleTask.Builder withInputFiles(org.gradle.api.file.FileCollection inputs)

Adds the files and/or directories to the input file set for the task being built.

If none of the specified file system elements are present before the task execution, the task will be marked as NO-SOURCE and skipped.

Multiple invocations appends the new files to the existing ones.

Parameters:

inputs - the task input files

Returns:

the current instance of Builder

withInputProperty

public GradleTask.Builder withInputProperty(java.lang.String propertyName,
                                            @Nullable java.io.Serializable value)

Adds a task input property.

An input property is treated in a similar way as an input file.

Multiple invocations of this method append new properties. If there already is a property with is such a name, the value is overridden.

Parameters:

propertyName - the name of the property

value - the value of the property

Returns:

the current instance of Builder

withOutputFiles

public GradleTask.Builder withOutputFiles(org.gradle.api.file.FileCollection outputs)

Adds the files and/or directories to the output file set for the task being built.

If all the files listed as output do not change since the previous run of the task, the task will be marked as UP-TO-DATE and skipped.

Note that a task is not skipped if its inputs are changes.

Parameters:

outputs - the task output files

Returns:

the current instance of Builder

applyNowTo

@CanIgnoreReturnValue
public GradleTask applyNowTo(org.gradle.api.Project project)

Builds an instance of GradleTask and inserts it to the project build lifecycle according to the "before" and "after" tasks specified in the builder.

Parameters:

project - the target Gradle project

Returns:

the newly created Gradle task