Class ScriptExecutor

java.lang.Object

org.jdrupes.builder.core.AbstractProvider

org.jdrupes.builder.core.ScriptExecutor

All Implemented Interfaces:

Renamable, RequiredResourceSupport, ResourceProvider

public class ScriptExecutor
extends AbstractProvider
implements Renamable, RequiredResourceSupport

A provider of execution results from invoking a script executed by a configurable interpreter. The provider generates resources in response to requests for ExecResult whose name matches this provider's name.

• The working directory is the project directory.

• The provider retrieves all resources added by required(Stream). While the provider itself does not process these resources, it is assumed that they are processed by the script and therefore need to be available.

• The provider invokes the function configured with output(Function) and collects all resources. If the generated resources exist and no resource from required is newer than the generated resources found, the provider returns a result that indicates successful invocation. The date of the result is set to the newest date from the generated resources and the (existing) resources are attached.

• Else, the provider executes the script, calls the function set with output(Function) again and adds the result to the ExecResult that it returns.

The generated resources can also be provided directly (i.e. not as part of an ExecResult) in response to a configurable resource request, see provideResources(ResourceRequest, Function).

The provider also uses the function set with output(Function) to determine the resources to be removed when it is invoked with a request for Cleanliness.

Constructor Summary

Constructors

Constructor	Description
ScriptExecutor(Project project)	Initializes a new script executor.

Method Summary

Modifier and Type	Method	Description
ScriptExecutor	args(String... args)	Add the given arguments as arguments of the script.
ScriptExecutor	args(Stream<String> args)	Add the strings from the stream as arguments of the script, see args(String...).
protected <T extends Resource> Collection<T>	doProvide(ResourceRequest<T> request)	Invoked by ResourceProviderSpi.provide(ResourceRequest) after checking if the invocation is allowed.
ScriptExecutor	interpreter(Path interpreter)	Sets the path to the interpreter that is to be invoked.
ScriptExecutor	interpreterFlags(String... flags)	Adds the given flags to the interpreter invocation.
ScriptExecutor	name(String name)	Set the new name.
ScriptExecutor	output(Function<Project, Stream<Resource>> resources)	Sets the function used to determine the resources generated by this provider.
Project	project()	Returns the project that this provider belongs to.
ScriptExecutor	provideResources(ResourceRequest<?> proto, Function<Project, Stream<Resource>> resources)	Provide the generated resources directly in response to a requests like the given prototype request.
ScriptExecutor	required(Path file)	Convenience method that adds a FileResource to the required resources.
ScriptExecutor	required(Path root, String pattern)	Convenience method that adds a FileTree to the required resources.
ScriptExecutor	required(Stream<? extends Resource> resources)	Required.
ScriptExecutor	script(String script)	Sets the script to be executed.
ScriptExecutor	scriptArgumentFlag(String flag)	Sets the flag that precedes a script passed to the interpreter on the command line.
ScriptExecutor	scriptFile(Path script)	Sets the script file to be executed.
String	toString()	To string.

Methods inherited from class AbstractProvider

context, name, of, rename, vavrStream

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ResourceProvider

context, name, of, resources

Constructor Details

ScriptExecutor

public ScriptExecutor(Project project)

Initializes a new script executor.

Parameters:

project - the project

Method Details

project

public Project project()

Returns the project that this provider belongs to.

Returns:

the project

name

public ScriptExecutor name(String name)

Description copied from interface: Renamable

Set the new name.

Specified by:

name in interface Renamable

Parameters:

name - the name

Returns:

the renamable

interpreter

public ScriptExecutor interpreter(Path interpreter)

Sets the path to the interpreter that is to be invoked.

Parameters:

interpreter - the interpreter

Returns:

the script executor

interpreterFlags

public ScriptExecutor interpreterFlags(String... flags)

Adds the given flags to the interpreter invocation.

Parameters:

flags - the flags

Returns:

the script executor

scriptFile

public ScriptExecutor scriptFile(Path script)

Sets the script file to be executed.

Parameters:

script - the script

Returns:

the script executor

scriptArgumentFlag

public ScriptExecutor scriptArgumentFlag(String flag)

Sets the flag that precedes a script passed to the interpreter on the command line. Defaults to "-c".

Parameters:

flag - the flag

Returns:

the script executor

script

public ScriptExecutor script(String script)

Sets the script to be executed.

Parameters:

script - the script

Returns:

the script executor

args

public ScriptExecutor args(String... args)

Add the given arguments as arguments of the script. Note that the absolute path of the script or, when using script(String), this provider's name is automatically added as the first argument, before the arguments specified by this method.

Parameters:

args - the arguments

Returns:

the script executor

args

public ScriptExecutor args(Stream<String> args)

Add the strings from the stream as arguments of the script, see args(String...).

Parameters:

args - the args

Returns:

the script executor

required

public ScriptExecutor required(Stream<? extends Resource> resources)

Required.

Specified by:

required in interface RequiredResourceSupport

Parameters:

resources - the resources

Returns:

the script executor

required

public ScriptExecutor required(Path root,
 String pattern)

Description copied from interface: RequiredResourceSupport

Convenience method that adds a FileTree to the required resources. If root is relative, it is resolved against the project's directory.

Specified by:

required in interface RequiredResourceSupport

Parameters:

root - the root

pattern - the pattern

Returns:

the provider

required

public ScriptExecutor required(Path file)

Description copied from interface: RequiredResourceSupport

Convenience method that adds a FileResource to the required resources. If path is relative, it is resolved against the project's directory.

Specified by:

required in interface RequiredResourceSupport

Parameters:

file - the file

Returns:

the provider

output

public ScriptExecutor output(Function<Project, Stream<Resource>> resources)

Sets the function used to determine the resources generated by this provider. The function is evaluated both for incremental up-to-date checks, for determining the resources returned after script execution, and for determining the resources to be cleaned.

Parameters:

resources - the function that provides the results as resources

Returns:

the script executor

provideResources

public ScriptExecutor provideResources(ResourceRequest<?> proto,
 Function<Project, Stream<Resource>> resources)

Provide the generated resources directly in response to a requests like the given prototype request. Invoking this method implies a call to output(Function) with resources.

Parameters:

proto - defines the kind of request that the script executor should respond to with the generated resources

resources - the function that provides the results as resources

Returns:

the script executor

doProvide

protected <T extends Resource> Collection<T> doProvide(ResourceRequest<T> request)

Description copied from class: AbstractProvider

Invoked by ResourceProviderSpi.provide(ResourceRequest) after checking if the invocation is allowed.

Specified by:

doProvide in class AbstractProvider

Type Parameters:

T - the generic type

Parameters:

request - the request for resources

Returns:

the stream

toString

public String toString()

To string.

Overrides:

toString in class AbstractProvider

Returns:

the string