AbstractJvmExecSpec (docs 2.1.1 API)

org.ysb33r.grolifant.api.core.runnable.AbstractJvmExecSpec

All Implemented Interfaces and Traits:

ForkedJvmExecutable
```
public class AbstractJvmExecSpec<T extends AbstractJvmExecSpec<T>>
```
A base class for specifying the execution of an entrypoint on a forked JVM.
Authors:
Schalk W. Cronjé
Since:
2.0

Constructor Summary

Constructors
Constructor and description
`protected AbstractJvmExecSpec (ProjectOperations po)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public void`	`copyTo(JavaExecSpec execSpec)` Copies this specification to a standard JavaExecSpec.
	`public T`	`entrypoint(Action<JvmEntryPoint> configurator)` Configures the entrypoint for the JVM executable
	`public T`	`entrypoint(groovy.lang.Closure<?> configurator)` Configures the entrypoint for the JVM executable
	`protected JvmAppRunnerSpec`	`getJvmForkOptions()`
	`public T`	`jvm(Action<JavaForkOptionsWithEnvProvider> configurator)` Configures a JVM that will be forked.
	`public T`	`jvm(groovy.lang.Closure<?> configurator)` Configures a JVM that will be forked.
	`public T`	`process(Action<ProcessExecutionSpec> configurator)` Configures the stream redirection and exit code checks.
	`public T`	`process(groovy.lang.Closure<?> configurator)` Configures the stream redirections and exit checks.
	`public T`	`runnerSpec(Action<CmdlineArgumentSpec> configurator)` Configures the arguments.
	`public T`	`runnerSpec(groovy.lang.Closure<?> configurator)` Configures the arguments.
`<P extends SerializableWorkerAppParameters>`	`public WorkerPromise`	`submitToWorkQueue(WorkerIsolation isolationMode, WorkerExecutor worker, WorkerAppExecutorFactory<P> workerAppExecutorFactory, WorkerAppParameterFactory<P> parameterFactory)` Submits this to a worker queue using an appropriate isolation mode.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Constructor Detail
  - protected AbstractJvmExecSpec(ProjectOperations po)
- Method Detail
  - public void copyTo(JavaExecSpec execSpec)
    
    Copies this specification to a standard JavaExecSpec.
    Parameters:
    execSpec - Target execution specification.
  - @Override public T entrypoint(Action<JvmEntryPoint> configurator)
    
    Configures the entrypoint for the JVM executable
    Parameters:
    configurator - An action to configure the entrypoint
    Returns:
    The configured executable.
  - @Override public T entrypoint(@groovy.lang.DelegatesTo(JvmEntryPoint.class) groovy.lang.Closure<?> configurator)
    
    Configures the entrypoint for the JVM executable
    Parameters:
    configurator - A closure to configure the entrypoint
    Returns:
    The configured executable.
  - @Nested protected JvmAppRunnerSpec getJvmForkOptions()
  - @Override public T jvm(Action<JavaForkOptionsWithEnvProvider> configurator)
    
    Configures a JVM that will be forked.
    Parameters:
    configurator - An action to configure the JVM's fork options.
    Returns:
    The configured executable
  - @Override public T jvm(@groovy.lang.DelegatesTo(JavaForkOptionsWithEnvProvider.class) groovy.lang.Closure<?> configurator)
    
    Configures a JVM that will be forked.
    Parameters:
    configurator - A closure to configure the JVM's fork options.
    Returns:
    The configured executable
  - @Override public T process(Action<ProcessExecutionSpec> configurator)
    
    Configures the stream redirection and exit code checks.
    Parameters:
    configurator - An action to configure the execution.
    Returns:
    The configured executable.
  - @Override public T process(@groovy.lang.DelegatesTo(ProcessExecutionSpec.class) groovy.lang.Closure<?> configurator)
    
    Configures the stream redirections and exit checks.
    Parameters:
    configurator - A closure to configure the execution.
    Returns:
    The configured executable.
  - @Override public T runnerSpec(Action<CmdlineArgumentSpec> configurator)
    
    Configures the arguments.
    Parameters:
    configurator - An action to configure the arguments.
    Returns:
    The configured executable
  - @Override public T runnerSpec(@groovy.lang.DelegatesTo(CmdlineArgumentSpec.class) groovy.lang.Closure<?> configurator)
    
    Configures the arguments.
    Parameters:
    configurator - A closure to configure the arguments.
    Returns:
    The configured executable
  - <P extends SerializableWorkerAppParameters> public WorkerPromise submitToWorkQueue(WorkerIsolation isolationMode, WorkerExecutor worker, WorkerAppExecutorFactory<P> workerAppExecutorFactory, WorkerAppParameterFactory<P> parameterFactory)
    
    Submits this to a worker queue using an appropriate isolation mode.
    Parameters:
    isolationMode - Isolation mode which is either classpath isolated or out of process.
    worker - A worker execution instance.
    workerAppExecutorFactory - A factory instances that can create executor logic.
    parameterFactory - A factory which can create parameters and populate them from a JavaExecSpec.
    Type Parameters:
    P - The type of the POJO/POGO that holds the parameters.

Summary:
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Java] Class AbstractJvmExecSpec<T extends AbstractJvmExecSpec<T>>

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

protected AbstractJvmExecSpec(ProjectOperations po)

Method Detail

public void copyTo(JavaExecSpec execSpec)

@Override public T entrypoint(Action<JvmEntryPoint> configurator)

@Override public T entrypoint(@groovy.lang.DelegatesTo(JvmEntryPoint.class) groovy.lang.Closure<?> configurator)

@Nested protected JvmAppRunnerSpec getJvmForkOptions()

@Override public T jvm(Action<JavaForkOptionsWithEnvProvider> configurator)

@Override public T jvm(@groovy.lang.DelegatesTo(JavaForkOptionsWithEnvProvider.class) groovy.lang.Closure<?> configurator)

@Override public T process(Action<ProcessExecutionSpec> configurator)

@Override public T process(@groovy.lang.DelegatesTo(ProcessExecutionSpec.class) groovy.lang.Closure<?> configurator)

@Override public T runnerSpec(Action<CmdlineArgumentSpec> configurator)

@Override public T runnerSpec(@groovy.lang.DelegatesTo(CmdlineArgumentSpec.class) groovy.lang.Closure<?> configurator)

<P extends SerializableWorkerAppParameters> public WorkerPromise submitToWorkQueue(WorkerIsolation isolationMode, WorkerExecutor worker, WorkerAppExecutorFactory<P> workerAppExecutorFactory, WorkerAppParameterFactory<P> parameterFactory)