de.undercouch.gradle.tasks.download.internal

Class DefaultWorkerExecutorHelper

java.lang.Object

de.undercouch.gradle.tasks.download.internal.WorkerExecutorHelper

de.undercouch.gradle.tasks.download.internal.DefaultWorkerExecutorHelper

public class DefaultWorkerExecutorHelper
extends WorkerExecutorHelper

Default implementation of WorkerExecutorHelper that executes Jobs asynchronously using the Gradle Worker API

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultWorkerExecutorHelper.DefaultWorkAction
static interface	DefaultWorkerExecutorHelper.DefaultWorkParameters

Constructor Summary

Constructors

Constructor and Description
DefaultWorkerExecutorHelper(org.gradle.workers.WorkerExecutor workerExecutor) Constructs a new executor

Method Summary

Modifier and Type	Method and Description
void	await() Wait for all jobs of the current build operation to complete
boolean	needsAwait() Returns true if WorkerExecutorHelper.await() MUST be called at the end of the task.
void	submit(Job job) Execute a job asynchronously

Methods inherited from class de.undercouch.gradle.tasks.download.internal.WorkerExecutorHelper

newInstance

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultWorkerExecutorHelper

@Inject
public DefaultWorkerExecutorHelper(org.gradle.workers.WorkerExecutor workerExecutor)

Constructs a new executor

Parameters:

workerExecutor - the Gradle Worker API executor

Method Detail

submit

public void submit(Job job)

Description copied from class: WorkerExecutorHelper

Execute a job asynchronously

Specified by:

submit in class WorkerExecutorHelper

Parameters:

job - the job to execute

await

public void await()

Description copied from class: WorkerExecutorHelper

Wait for all jobs of the current build operation to complete

Specified by:

await in class WorkerExecutorHelper

needsAwait

public boolean needsAwait()

Description copied from class: WorkerExecutorHelper

Returns true if WorkerExecutorHelper.await() MUST be called at the end of the task. This mostly applies to Gradle versions that don't have a Worker API and therefore cannot let the task continue to run in parallel to others.

Specified by:

needsAwait in class WorkerExecutorHelper

Returns:

true if WorkerExecutorHelper.await() must be called