Method Detail

• public void addCommandLineProcessor(String name, Integer order, CmdlineArgumentSpec processor)

  Adds a command-line processor that will process command-line arguments in a specific order. For instance in a script, one want to proccess the exe args before the script args. In a system that has commands and subcommands, one wants to process this in the order of exe args, command args, and then subcommand args. This method allows the implementor to control the order of processing for all the groupings.

  Parameters:

  name - Name of command-line processor.

  order - Order in queue to process.

  processor - The specific grouping.

• public void configureCmdline(Action<CmdlineArgumentSpec> configurator)

  Configures a CmdlineArgumentSpec instance.

  Parameters:

  configurator - Configurator.

• public void configureCmdline(@groovy.lang.DelegatesTo(CmdlineArgumentSpec.class) groovy.lang.Closure<?> configurator)

  Configures a CmdlineArgumentSpec instance.

  Parameters:

  configurator - Configurator.

• public void configureEntrypoint(Action<JvmEntryPoint> configurator)

  Configures a JvmEntryPoint instance.

  Parameters:

  configurator - Configurator.

• public void configureEntrypoint(@groovy.lang.DelegatesTo(JvmEntryPoint.class) groovy.lang.Closure<?> configurator)

  Configures a JvmEntryPoint instance.

  Parameters:

  configurator - Configurator.

• public void configureForkOptions(Action<JavaForkOptionsWithEnvProvider> configurator)

  Configures a JavaForkOptionsWithEnvProvider instance.

  Parameters:

  configurator - Configurator.

• public void configureForkOptions(@groovy.lang.DelegatesTo(JavaForkOptionsWithEnvProvider.class) groovy.lang.Closure<?> configurator)

  Configures a JavaForkOptionsWithEnvProvider instance.

  Parameters:

  configurator - Configurator.

• public void configureProcess(Action<ProcessExecutionSpec> configurator)

  Configures a ProcessExecutionSpec.

  Parameters:

  configurator - Configurator.

• public void configureProcess(@groovy.lang.DelegatesTo(ProcessExecutionSpec.class) groovy.lang.Closure<?> configurator)

  Configures a ProcessExecutionSpec.

  Parameters:

  configurator - Configurator.

• public JavaExecSpec copyTo(JavaExecSpec target)

  Copies these options to the given options.

  Parameters:

  target - The target options.

  Returns:

  The options that were passed in.

• @Internal public CmdlineArgumentSpec getCmdline()

  Direct access to the CmdlineArgumentSpec instance.

  Returns:

  Something that implements CmdlineArgumentSpec.

  Since:

  5.5

• @Internal public java.util.Collection<CmdLineArgumentSpecEntry> getCommandLineProcessors()

  Provides direct access to the list of command-line processors. In many cases there will only be one item in the list which is for providing arguments to the executable itself. Some implementations will have more. Implementors can use this interface to manipulate order of evaluation.

  Returns:

  Collection of command-line processors. Can be empty, but never null.

• @Internal public JvmEntryPoint getEntrypoint()

  Direct access to the JvmEntryPoint instance.

  Returns:

  Something that implements JvmEntryPoint.

  Since:

  5.5

• @Input public String getExecutionSignature()

  A unique string which determines whether there were any changes.

  Returns:

  Signature string

• @Internal public JavaForkOptionsWithEnvProvider getForkOptions()

  Direct access to the JavaForkOptionsWithEnvProvider instance.

  Returns:

  The fork options.

  Since:

  5.5

• @Internal public ProcessExecutionSpec getProcess()

  Direct access to the ProcessExecutionSpec instance.

  Returns:

  Something that implements ProcessExecutionSpec.

  Since:

  5.5

• public ExecOutput submitAsJavaExec(AbstractJvmExecSpec spec)

  Runs a job using javaexec.

  Parameters:

  spec - Execution specification

  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 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.

• 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 class.

  This method ignores any main class that has been set in the execution spec. Ig it up to the caller to set a class that may or may not call the main class.

  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