Package org.apache.maven.shared.scriptinterpreter

Interface ScriptInterpreter

All Superinterfaces:

AutoCloseable, Closeable

public interface ScriptInterpreter
extends Closeable

Defines a simple abstraction used to plug-in several script interpreters for the pre-/post-build-hooks. Each interpreter implementation should be stateless and support reuse.

Author:

Benjamin Bentmann

Method Summary

Modifier and Type	Method	Description
Object	evaluateScript(String script, Map<String,?> globalVariables, PrintStream scriptOutput)	Evaluates the specified script.
void	setClassPath(List<String> classPath)	Set class path used by interpreted.

Methods inherited from interface java.io.Closeable

close

Method Details

setClassPath

void setClassPath(List<String> classPath)

Set class path used by interpreted.

Parameters:

classPath - The additional class path for the script interpreter, may be null or empty if only the plugin realm should be used for the script evaluation. If specified, this class path will precede the artifacts from the plugin class path.

evaluateScript

Object evaluateScript(String script,
 Map<String,?> globalVariables,
 PrintStream scriptOutput)
               throws ScriptEvaluationException

Evaluates the specified script.

Parameters:

script - The script contents to evaluate, must not be null.

globalVariables - The global variables (as a mapping from variable name to value) to define for the script, may be null if not used.

scriptOutput - A print stream to redirect any output from the script to, may be null to use stdout/stderr.

Returns:

The return value from the script, can be null

Throws:

ScriptEvaluationException - If the script evaluation produced an error.