Class DefaultPhasedBuildActionExecuter

    • Method Detail

      • 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 interface BuildActionExecuter<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 interface BuildActionExecuter<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 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's ResultHandler.onComplete(Object) method.

        If the operation fails, the handler's ResultHandler.onFailure(GradleConnectionException) method is called with the appropriate exception. See BuildActionExecuter.run() for a description of the various exceptions that the operation may fail with.

        Specified by:
        run in interface BuildActionExecuter<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.