AbstractJvmExecSpec (Grolifant Core API)

org.ysb33r.grolifant5.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)`
`protected AbstractJvmExecSpec (ConfigCacheSafeOperations po)` Constructs the basics of a Jvm execution specification.

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
	`public JvmEntryPoint`	`getEntrypoint()` Get direct access to the JvmEntryPoint instance.
	`public JavaForkOptionsWithEnvProvider`	`getJvm()` Direct access to the JavaForkOptionsWithEnvProvider instance.
	`protected JvmAppRunnerSpec`	`getJvmAppRunnerSpec()`
	`public ProcessExecutionSpec`	`getProcess()` Get direct access to the ProcessExecutionSpec instance.
	`public CmdlineArgumentSpec`	`getRunnerSpec()` Get direct access to the CmdlineArgumentSpec instance.
	`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.
	`public ExecOutput`	`submitAsJavaExec()` Runs a job using `javaexec`.
`<P extends SerializableWorkerAppParameters>`	`public WorkerPromise`	`submitToWorkQueue(WorkerIsolation isolationMode, WorkerExecutor worker, org.ysb33r.grolifant5.api.remote.worker.WorkerAppExecutorFactory<P> workerAppExecutorFactory, WorkerAppParameterFactory<P> parameterFactory)` Submits this to a worker queue using an appropriate isolation mode.
	`public WorkerPromise`	`submitToWorkQueue(WorkerIsolation isolationMode, WorkerExecutor worker, Class<? extends WorkerAppCmdline> workerType)` This method submits this job to a worker queue using a special worker type to invoke the cla

Inherited Methods Summary

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

- Constructor Detail
  - @Deprecated protected AbstractJvmExecSpec(ProjectOperations po)
  - protected AbstractJvmExecSpec(ConfigCacheSafeOperations po)
    
    Constructs the basics of a Jvm execution specification.
    Parameters:
    po - Implementation of ConfigCacheSafeOperations.
    Since:
    5.0
- 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.
  - @Override public JvmEntryPoint getEntrypoint()
    
    Get direct access to the JvmEntryPoint instance.
    Returns:
    Something that implements JvmEntryPoint.
    Since:
    5.5
  - @Override public JavaForkOptionsWithEnvProvider getJvm()
    
    Direct access to the JavaForkOptionsWithEnvProvider instance.
    Returns:
    The fork options.
    Since:
    5.5
  - @Nested protected JvmAppRunnerSpec getJvmAppRunnerSpec()
  - @Override public ProcessExecutionSpec getProcess()
    
    Get direct access to the ProcessExecutionSpec instance.
    Returns:
    Something that implements ProcessExecutionSpec.
    Since:
    5.5
  - @Override public CmdlineArgumentSpec getRunnerSpec()
    
    Get direct access to the CmdlineArgumentSpec instance.
    Returns:
    Something that implements CmdlineArgumentSpec.
    Since:
    5.5
  - @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
  - public ExecOutput submitAsJavaExec()
    
    Runs a job using javaexec.
    Returns:
    Result of execution.
    Since:
    5.0
  - <P extends SerializableWorkerAppParameters> @Deprecated public WorkerPromise submitToWorkQueue(WorkerIsolation isolationMode, WorkerExecutor worker, org.ysb33r.grolifant5.api.remote.worker.WorkerAppExecutorFactory<P> workerAppExecutorFactory, WorkerAppParameterFactory<P> parameterFactory)
    
    Submits this to a worker queue using an appropriate isolation mode.
    deprecated:
    This method originally existed to handle workers in Gradle 6.x - 8.x. As the minimum supported Gradle is now 7.3.3, this method is now deprecated and will be removed in Grolifant 6.0. Use submitToWorkQueue(WorkerIsolation, WorkerExecutor, Class) instead.
    
    Parameters:
    isolationMode - Isolation mode which is either classpath isolated or out of process.
    worker - A worker execution instance.
    workerAppExecutorFactory - A factory instance 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.
  - public WorkerPromise submitToWorkQueue(WorkerIsolation isolationMode, WorkerExecutor worker, Class<? extends WorkerAppCmdline> workerType)
    
    This method submits this job to a worker queue using a special worker type to invoke the cla
    Parameters:
    isolationMode - Isolation mode which is either classpath isolated or out of process.
    worker - Worker executor to submit to.
    workerType - The class type that will be launched inside the worker.
    Returns:
    A promise that will allow the calling process to wait for the worker to complete.
    Since:
    5.5

Summary:
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

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

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

@Deprecated protected AbstractJvmExecSpec(ProjectOperations po)

protected AbstractJvmExecSpec(ConfigCacheSafeOperations 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)

@Override public JvmEntryPoint getEntrypoint()

@Override public JavaForkOptionsWithEnvProvider getJvm()

@Nested protected JvmAppRunnerSpec getJvmAppRunnerSpec()

@Override public ProcessExecutionSpec getProcess()

@Override public CmdlineArgumentSpec getRunnerSpec()

@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)

public ExecOutput submitAsJavaExec()

<P extends SerializableWorkerAppParameters> @Deprecated public WorkerPromise submitToWorkQueue(WorkerIsolation isolationMode, WorkerExecutor worker, org.ysb33r.grolifant5.api.remote.worker.WorkerAppExecutorFactory<P> workerAppExecutorFactory, WorkerAppParameterFactory<P> parameterFactory)

public WorkerPromise submitToWorkQueue(WorkerIsolation isolationMode, WorkerExecutor worker, Class<? extends WorkerAppCmdline> workerType)