Package org.scijava.script

Interface ScriptLanguage

All Superinterfaces:

Comparable<Prioritized>, Contextual, HasPluginInfo, Identifiable, Locatable, Logged, Prioritized, RichPlugin, SciJavaPlugin, ScriptEngineFactory, SingletonPlugin, Versioned

All Known Implementing Classes:

AbstractScriptLanguage, AdaptedScriptLanguage

public interface ScriptLanguage
extends ScriptEngineFactory, RichPlugin, SingletonPlugin

The base interface for scripting language adapters.

Every SciJava scripting language implements this interface, which is based on JSR 223, Scripting for the Java Platform, included in Java 6 and later in the javax.script package. This ScriptLanguage interface extends ScriptEngineFactory, meaning it can act as a JSR 223 Java scripting language, while also providing additional functionality necessary for full support within applications such as ImageJ. In particular, this interface adds API for code generation of scripts to replicate SciJava Module executions (i.e., for "script recording" of SciJava commands).

Script languages discoverable at runtime must implement this interface and be annotated with @Plugin with attribute Plugin.type() = ScriptLanguage.class. While it possible to create a scripting language adapter merely by implementing this interface, it is encouraged to instead extend AbstractScriptLanguage, for convenience.

Author:

Johannes Schindelin, Curtis Rueden, Hadrien Mary

Method Summary

Modifier and Type	Method	Description
default Object	decode(Object object)	Performs any necessary conversion of an encoded object retrieved from the language's script engine.
default AutoCompleter	getAutoCompleter()	Gets a helper object capable of generating autocomplete suggestions for a code fragment.
default String	getEngineVersion()
default List<String>	getExtensions()
default String	getLanguageVersion()
default String	getMethodCallSyntax(String obj, String m, String... args)
default List<String>	getMimeTypes()
default List<String>	getNames()
default String	getOutputStatement(String toDisplay)
default Object	getParameter(String key)
default String	getProgram(String... statements)
default boolean	isCompiledLanguage()	True iff this language requires a compilation step.

Methods inherited from interface org.scijava.Contextual

context, getContext, setContext

Methods inherited from interface org.scijava.plugin.HasPluginInfo

getInfo, setInfo

Methods inherited from interface org.scijava.Locatable

getLocation

Methods inherited from interface org.scijava.Prioritized

compareTo, getPriority, setPriority

Methods inherited from interface org.scijava.plugin.RichPlugin

getIdentifier, log

Methods inherited from interface javax.script.ScriptEngineFactory

getEngineName, getLanguageName, getScriptEngine

Methods inherited from interface org.scijava.Versioned

getVersion

Method Detail

isCompiledLanguage

default boolean isCompiledLanguage()

True iff this language requires a compilation step.

decode

default Object decode(Object object)

Performs any necessary conversion of an encoded object retrieved from the language's script engine.

See Also:

ScriptEngine.get(String)

getAutoCompleter

default AutoCompleter getAutoCompleter()

Gets a helper object capable of generating autocomplete suggestions for a code fragment.

getMethodCallSyntax

default String getMethodCallSyntax(String obj,
                                   String m,
                                   String... args)

Specified by:

getMethodCallSyntax in interface ScriptEngineFactory

getOutputStatement

default String getOutputStatement(String toDisplay)

Specified by:

getOutputStatement in interface ScriptEngineFactory

getProgram

default String getProgram(String... statements)

Specified by:

getProgram in interface ScriptEngineFactory

getExtensions

default List<String> getExtensions()

Specified by:

getExtensions in interface ScriptEngineFactory

getNames

default List<String> getNames()

Specified by:

getNames in interface ScriptEngineFactory

getLanguageVersion

default String getLanguageVersion()

Specified by:

getLanguageVersion in interface ScriptEngineFactory

getMimeTypes

default List<String> getMimeTypes()

Specified by:

getMimeTypes in interface ScriptEngineFactory

getParameter

default Object getParameter(String key)

Specified by:

getParameter in interface ScriptEngineFactory

getEngineVersion

default String getEngineVersion()

Specified by:

getEngineVersion in interface ScriptEngineFactory