dev.nokee.core.exec

Interface CommandLineToolExecutionEngine<T extends CommandLineToolExecutionHandle>

Type Parameters:

T - The handle type returned by this engine for each submitted invocation.

All Known Implementing Classes:

CachingProcessBuilderEngine, GradleWorkerExecutorEngine, LoggingEngine, ProcessBuilderEngine

public interface CommandLineToolExecutionEngine<T extends CommandLineToolExecutionHandle>

A execution engine models how a command line tool will be executed. It convert an agnostic invocation into an handle for the execution within the engine.

Method Summary

Modifier and Type	Method and Description
T	submit(CommandLineToolInvocation invocation) Schedule specified CommandLineToolInvocation for execution using this engine.

Method Detail

submit

T submit(CommandLineToolInvocation invocation)

Schedule specified CommandLineToolInvocation for execution using this engine. Once the execution is scheduled, it's up to the engine to decide when the execution will start. The returned handle allows some control over the execution, not all engine support the same set of features. Refer to the specific execution engine documentation.

NOTE: A execution engine may not support all the feature an invocation may be requesting. It is up to the strategy of each engine to decide if the feature will be ignored or an exception will be thrown.

Parameters:

invocation - the command line invocation information to execute

Returns:

a CommandLineToolExecutionHandle instance, never null.