org.scijava.plugins.scripting.java

Class JavaEngine

java.lang.Object

org.scijava.script.AbstractScriptEngine

org.scijava.plugins.scripting.java.JavaEngine

All Implemented Interfaces:

ScriptEngine, org.scijava.log.Logged

public class JavaEngine
extends org.scijava.script.AbstractScriptEngine

A pseudo-ScriptEngine compiling and executing Java classes.

Thanks to MiniMaven, this script engine can handle individual Java classes as well as trivial Maven projects (triggered when the proviede script path suggests that the file is part of a Maven project).

Author:

Johannes Schindelin, Jonathan Hale

Field Summary

Fields inherited from class org.scijava.script.AbstractScriptEngine

engineScopeBindings, scriptContext

Fields inherited from interface javax.script.ScriptEngine

ARGV, ENGINE, ENGINE_VERSION, FILENAME, LANGUAGE, LANGUAGE_VERSION, NAME

Constructor Summary

Constructors

Constructor and Description
JavaEngine()

Method Summary

Modifier and Type	Method and Description
void	compile(File file) Compiles the specified .java file.
void	compile(File file, Writer errorWriter) Compiles the specified .java file.
Class<?>	compile(Reader reader) Compiles and runs the specified .java class.
Class<?>	compile(String script) Compiles and runs the specified .java class.
Object	eval(Reader reader) Compiles and runs the specified .java class.
Object	eval(String script) Compiles and runs the specified .java class.
void	makeJar(File file, boolean includeSources, File output, Writer errorWriter) Packages the build product into a .jar file.

Methods inherited from class org.scijava.script.AbstractScriptEngine

createBindings, eval, eval, eval, eval, get, getBindings, getContext, getFactory, log, put, setBindings, setContext, setLogService

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaEngine

public JavaEngine()

Method Detail

eval

public Object eval(String script)
            throws ScriptException

Compiles and runs the specified .java class. If a filename is set in the engine scope bindings via the ScriptEngine.FILENAME key, this method compiles that file and runs the resulting main class instead.

The currently active RunService is responsible for running the class.

Specified by:

eval in interface ScriptEngine

Specified by:

eval in class org.scijava.script.AbstractScriptEngine

Parameters:

script - the source code for a Java class

Returns:

null

Throws:

ScriptException

eval

public Object eval(Reader reader)
            throws ScriptException

Compiles and runs the specified .java class. If a filename is set in the engine scope bindings via the ScriptEngine.FILENAME key, this method compiles that file and runs the resulting main class instead.

The currently active RunService is responsible for running the class.

Specified by:

eval in interface ScriptEngine

Specified by:

eval in class org.scijava.script.AbstractScriptEngine

Parameters:

reader - the reader producing the source code for a Java class

Returns:

null

Throws:

ScriptException

compile

public Class<?> compile(String script)
                 throws ScriptException

Compiles and runs the specified .java class. If a filename is set in the engine scope bindings via the ScriptEngine.FILENAME key, this method compiles that file and returns its resulting main class instead.

Parameters:

script - the source code for a Java class

Returns:

the compiled Java class as Class.

Throws:

ScriptException

compile

public Class<?> compile(Reader reader)
                 throws ScriptException

Compiles and runs the specified .java class. If a filename is set in the engine scope bindings via the ScriptEngine.FILENAME key, this method compiles that file and returns its resulting main class instead.

Parameters:

reader - the reader producing the source code for a Java class

Returns:

the compiled Java class as Class.

Throws:

ScriptException

compile

public void compile(File file)

Compiles the specified .java file. Errors are written to the context error writer.

Parameters:

file - the source code

See Also:

compile(File, Writer), compile(Reader), compile(String)

compile

public void compile(File file,
                    Writer errorWriter)

Compiles the specified .java file. Errors are written to the specified errorWriter or if it is null, to the context error writer.

Parameters:

file - the source code

errorWriter - where to write the errors or null to use context errorWriter

See Also:

compile(File), compile(Reader), compile(String)

makeJar

public void makeJar(File file,
                    boolean includeSources,
                    File output,
                    Writer errorWriter)

Packages the build product into a .jar file.

Parameters:

file - a .java or pom.xml file

includeSources - whether to include the sources or not

output - the .jar file to write to

errorWriter - the destination for error messages