org.apache.maven.plugins.scripting

Class FileScriptEvaluator

java.lang.Object

org.apache.maven.plugins.scripting.FileScriptEvaluator

public class FileScriptEvaluator
extends Object

Evaluates a script held in a file. Use the engine name to override the engine if the file name does not refer/decode to a valid engine name or not define any at all.

Author:

Rusi Popov

Constructor Summary

Constructors

Constructor and Description
FileScriptEvaluator(String engineName, File scriptFile)

Method Summary

Modifier and Type	Method and Description
Object	eval(Bindings bindings)
protected Object	eval(ScriptEngine engine, ScriptContext context) AbstractScriptEvaluator the script
protected ScriptEngine	getEngine(ScriptEngineManager manager) Gets the script engine by engineName, otherwise by extension of the sciptFile

Methods inherited from class java.lang.Object

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

Constructor Detail

FileScriptEvaluator

public FileScriptEvaluator(String engineName,
                           File scriptFile)

Parameters:

engineName - optional engine name, used to override the engine selection from the file extension

scriptFile - not null

Method Detail

eval

protected Object eval(ScriptEngine engine,
                      ScriptContext context)
               throws ScriptException

AbstractScriptEvaluator the script

Parameters:

engine - the script engine.

context - the script context.

Returns:

the result of the scriptFile.

Throws:

ScriptException - if an error occurs in script.

See Also:

AbstractScriptEvaluator.eval(javax.script.ScriptEngine, javax.script.ScriptContext)

getEngine

protected ScriptEngine getEngine(ScriptEngineManager manager)
                          throws UnsupportedScriptEngineException

Gets the script engine by engineName, otherwise by extension of the sciptFile

Parameters:

manager - the script engine manager

Returns:

non-null engine to execute the script

Throws:

UnsupportedScriptEngineException - if specified engine is not available

See Also:

AbstractScriptEvaluator.getEngine(javax.script.ScriptEngineManager)

eval

public final Object eval(Bindings bindings)
                  throws ScriptException,
                         UnsupportedScriptEngineException

Parameters:

bindings - not null bindings to provide to the script to execute

Returns:

the possibly null result the script produced

Throws:

UnsupportedScriptEngineException - when the engine is not configured correctly

ScriptException - if an error occurs in script.