Class DefaultPhasedBuildActionExecuter
- java.lang.Object
-
- org.gradle.tooling.internal.consumer.AbstractLongRunningOperation<DefaultPhasedBuildActionExecuter>
-
- org.gradle.tooling.internal.consumer.DefaultPhasedBuildActionExecuter
-
- All Implemented Interfaces:
BuildActionExecuter<java.lang.Void>
,ConfigurableLauncher<BuildActionExecuter<java.lang.Void>>
,LongRunningOperation
public class DefaultPhasedBuildActionExecuter extends AbstractLongRunningOperation<DefaultPhasedBuildActionExecuter> implements BuildActionExecuter<java.lang.Void>
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.gradle.tooling.BuildActionExecuter
BuildActionExecuter.Builder
-
-
Field Summary
-
Fields inherited from class org.gradle.tooling.internal.consumer.AbstractLongRunningOperation
connectionParameters, operationParamsBuilder
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BuildActionExecuter<java.lang.Void>
forTasks(java.lang.Iterable<java.lang.String> tasks)
Specifies the tasks to execute before executing the BuildAction.BuildActionExecuter<java.lang.Void>
forTasks(java.lang.String... tasks)
Specifies the tasks to execute before executing the BuildAction.protected DefaultPhasedBuildActionExecuter
getThis()
java.lang.Void
run()
Runs the action, blocking until its result is available.void
run(ResultHandler<? super java.lang.Void> handler)
Starts executing the action, passing the result to the given handler when complete.-
Methods inherited from class org.gradle.tooling.internal.consumer.AbstractLongRunningOperation
addArguments, addArguments, addJvmArguments, addJvmArguments, addProgressListener, addProgressListener, addProgressListener, addProgressListener, copyFrom, getConsumerOperationParameters, rationalizeInput, rationalizeInput, setColorOutput, setEnvironmentVariables, setJavaHome, setJvmArguments, setJvmArguments, setStandardError, setStandardInput, setStandardOutput, withArguments, withArguments, withCancellationToken, withInjectedClassPath
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.gradle.tooling.ConfigurableLauncher
addArguments, addArguments, addJvmArguments, addJvmArguments, addProgressListener, addProgressListener, addProgressListener, addProgressListener, setColorOutput, setEnvironmentVariables, setJavaHome, setJvmArguments, setJvmArguments, setStandardError, setStandardInput, setStandardOutput, withArguments, withArguments, withCancellationToken
-
-
-
-
Method Detail
-
getThis
protected DefaultPhasedBuildActionExecuter getThis()
- Specified by:
getThis
in classAbstractLongRunningOperation<DefaultPhasedBuildActionExecuter>
-
forTasks
public BuildActionExecuter<java.lang.Void> forTasks(java.lang.String... tasks)
Description copied from interface:BuildActionExecuter
Specifies the tasks to execute before executing the BuildAction.
If not configured or a null array, then no tasks will be executed. If an empty array, the default tasks for the build will be executed.
If the target Gradle version is >=6.8 then you can execute tasks from included builds. You can target tasks from included builds by specifying the task identity path (i.e.
':included-build-name:subproject-name:taskName'
).- Specified by:
forTasks
in interfaceBuildActionExecuter<java.lang.Void>
- Parameters:
tasks
- The paths of the tasks to be executed. Relative paths are evaluated relative to the project for which this launcher was created. An empty list will run the project's default tasks.- Returns:
- this
-
forTasks
public BuildActionExecuter<java.lang.Void> forTasks(java.lang.Iterable<java.lang.String> tasks)
Description copied from interface:BuildActionExecuter
Specifies the tasks to execute before executing the BuildAction.
If not configured or a null iterable, then no tasks will be executed. If an empty iterable, the default tasks for the build will be executed.
If the target Gradle version is >=6.8 then you can execute tasks from included builds. You can target tasks from included builds by specifying the task identity path (i.e.
':included-build-name:subproject-name:taskName'
).- Specified by:
forTasks
in interfaceBuildActionExecuter<java.lang.Void>
- Parameters:
tasks
- The paths of the tasks to be executed. Relative paths are evaluated relative to the project for which this launcher was created. An empty list will run the project's default tasks.- Returns:
- this
-
run
public java.lang.Void run() throws GradleConnectionException, java.lang.IllegalStateException
Description copied from interface:BuildActionExecuter
Runs the action, blocking until its result is available.- Specified by:
run
in interfaceBuildActionExecuter<java.lang.Void>
- Throws:
UnsupportedVersionException
- When the target Gradle version does not support build action execution.UnsupportedOperationConfigurationException
- When the target Gradle version does not support some requested configuration option.UnsupportedBuildArgumentException
- When there is a problem with build arguments provided byConfigurableLauncher.withArguments(String...)
.BuildActionFailureException
- When the build action fails with an exception.BuildCancelledException
- When the operation was cancelled before it completed successfully.BuildException
- On some failure executing the Gradle build.GradleConnectionException
- On some other failure using the connection.java.lang.IllegalStateException
- When the connection has been closed or is closing.
-
run
public void run(ResultHandler<? super java.lang.Void> handler) throws java.lang.IllegalStateException
Description copied from interface:BuildActionExecuter
Starts executing the action, passing the result to the given handler when complete. This method returns immediately, and the result is later passed to the given handler'sResultHandler.onComplete(Object)
method.If the operation fails, the handler's
ResultHandler.onFailure(GradleConnectionException)
method is called with the appropriate exception. SeeBuildActionExecuter.run()
for a description of the various exceptions that the operation may fail with.- Specified by:
run
in interfaceBuildActionExecuter<java.lang.Void>
- Parameters:
handler
- The handler to supply the result to.- Throws:
java.lang.IllegalStateException
- When the connection has been closed or is closing.
-
-