WorkerConfiguration (Gradle API 7.0.2)

All Superinterfaces:: ActionConfiguration, Describable, ForkingWorkerSpec, WorkerSpec

@Deprecated
public interface WorkerConfiguration
extends ActionConfiguration, ForkingWorkerSpec, Describable

Deprecated.

Represents the configuration of a worker. Used when submitting an item of work to the WorkerExecutor.

      workerExecutor.submit(RunnableWorkImpl.class) { WorkerConfiguration conf ->
          conf.isolationMode = IsolationMode.PROCESS

          forkOptions { JavaForkOptions options ->
              options.maxHeapSize = "512m"
              options.systemProperty 'some.prop', 'value'
              options.jvmArgs "-server"
          }

          classpath configurations.fooLibrary

          conf.params = [ "foo", file('bar') ]
      }

Since:: 3.5

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`classpath(Iterable<File> files)`	Deprecated. Adds a set of files to the classpath associated with the worker.
`Iterable<File>`	`getClasspath()`	Deprecated. Gets the classpath associated with the worker.
`ForkMode`	`getForkMode()`	Deprecated. Gets the forking mode for this worker, see `ForkMode`.
`IsolationMode`	`getIsolationMode()`	Deprecated. Gets the isolation mode for this worker, see `IsolationMode`.
`void`	`setClasspath(Iterable<File> files)`	Deprecated. Sets the classpath associated with the worker.
`void`	`setDisplayName(String displayName)`	Deprecated. Sets the name to use when displaying this item of work.
`void`	`setForkMode(ForkMode forkMode)`	Deprecated. Sets the forking mode for this worker, see `ForkMode`.
`void`	`setIsolationMode(IsolationMode isolationMode)`	Deprecated. Sets the isolation mode for this worker, see `IsolationMode`.

Methods inherited from interface org.gradle.api.ActionConfiguration
getParams, params, setParams

Methods inherited from interface org.gradle.api.Describable
getDisplayName

Methods inherited from interface org.gradle.workers.ForkingWorkerSpec
forkOptions, getForkOptions

- Method Detail
  - getIsolationMode
```
IsolationMode getIsolationMode()
```
    Deprecated.
    
    Gets the isolation mode for this worker, see IsolationMode.
    
    Returns:
    
    the isolation mode for this worker, see IsolationMode, defaults to IsolationMode.AUTO
    
    Since:
    
    4.0
  - setIsolationMode
```
void setIsolationMode(IsolationMode isolationMode)
```
    Deprecated.
    
    Sets the isolation mode for this worker, see IsolationMode.
    
    Parameters:
    
    isolationMode - the forking mode for this worker, see IsolationMode
    
    Since:
    
    4.0
  - classpath
```
void classpath(Iterable<File> files)
```
    Deprecated.
    
    Adds a set of files to the classpath associated with the worker.
    
    Parameters:
    
    files - - the files to add to the classpath
  - setClasspath
```
void setClasspath(Iterable<File> files)
```
    Deprecated.
    
    Sets the classpath associated with the worker.
    
    Parameters:
    
    files - - the files to set the classpath to
  - getClasspath
```
Iterable<File> getClasspath()
```
    Deprecated.
    
    Gets the classpath associated with the worker.
    
    Returns:
    
    the classpath associated with the worker
  - getForkMode
```
ForkMode getForkMode()
```
    Deprecated.
    
    Gets the forking mode for this worker, see ForkMode.
    
    Returns:
    
    the forking mode for this worker, see ForkMode, defaults to ForkMode.AUTO
  - setForkMode
```
void setForkMode(ForkMode forkMode)
```
    Deprecated.
    
    Sets the forking mode for this worker, see ForkMode.
    
    Parameters:
    
    forkMode - the forking mode for this worker, see ForkMode
  - setDisplayName
```
void setDisplayName(String displayName)
```
    Deprecated.
    
    Sets the name to use when displaying this item of work.
    
    Parameters:
    
    displayName - the name of this item of work

Interface WorkerConfiguration

Method Summary

Methods inherited from interface org.gradle.api.ActionConfiguration

Methods inherited from interface org.gradle.api.Describable

Methods inherited from interface org.gradle.workers.ForkingWorkerSpec

Method Detail

getIsolationMode

setIsolationMode

classpath

setClasspath

getClasspath

getForkMode

setForkMode

setDisplayName