de.undercouch.gradle.tasks.download.internal

Class WorkerExecutorHelper

java.lang.Object

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

Direct Known Subclasses:

DefaultWorkerExecutorHelper, LegacyWorkerExecutorHelper

public abstract class WorkerExecutorHelper
extends java.lang.Object

Executes jobs asynchronously. Either uses the Gradle Worker API (if available) or falls back to a legacy implementation using an ExecutorService.

Constructor Summary

Constructors

Constructor and Description
WorkerExecutorHelper()

Method Summary

Modifier and Type	Method and Description
abstract void	await() Wait for all jobs of the current build operation to complete
abstract boolean	needsAwait() Returns true if await() MUST be called at the end of the task.
static WorkerExecutorHelper	newInstance(org.gradle.api.model.ObjectFactory objectFactory) Creates a new instance of the WorkerExecutorHelper depending on the Gradle version
abstract void	submit(Job job) Execute a job asynchronously

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkerExecutorHelper

public WorkerExecutorHelper()

Method Detail

newInstance

public static WorkerExecutorHelper newInstance(org.gradle.api.model.ObjectFactory objectFactory)

Creates a new instance of the WorkerExecutorHelper depending on the Gradle version

Parameters:

objectFactory - creates Gradle model objects

Returns:

the helper

submit

public abstract void submit(Job job)

Execute a job asynchronously

Parameters:

job - the job to execute

await

public abstract void await()

Wait for all jobs of the current build operation to complete

needsAwait

public abstract boolean needsAwait()

Returns true if 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.

Returns:

true if await() must be called