Package org.scijava.run

Interface CodeRunner

All Superinterfaces:

Comparable<Prioritized>, Contextual, HandlerPlugin<Object>, HasPluginInfo, Identifiable, Locatable, Logged, Prioritized, RichPlugin, SciJavaPlugin, SingletonPlugin, Typed<Object>, TypedPlugin<Object>, Versioned

All Known Implementing Classes:

AbstractCodeRunner, CommandCodeRunner, MainCodeRunner, ModuleCodeRunner, ScriptCodeRunner

public interface CodeRunner
extends HandlerPlugin<Object>

A plugin which extends the RunService's execution handling. A CodeRunner knows how to execute code of a certain form, such as the main method of a Java Class, or an Identifiable SciJava module.

Code runner plugins discoverable at runtime must implement this interface and be annotated with @Plugin with attribute Plugin.type() = CodeRunner.class. While it possible to create a class runner plugin merely by implementing this interface, it is encouraged to instead extend AbstractCodeRunner, for convenience.

Author:

Curtis Rueden

Method Summary

Modifier and Type	Method	Description
default Class<Object>	getType()	Gets the type associated with the object.
void	run(Object code, Object... args)	Executes the code identified by the given object, passing the specified arguments as inputs.
void	run(Object code, Map<String,Object> inputMap)	Executes the code identified by the given object, passing the arguments in the specified map as inputs.

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 org.scijava.Typed

supports

Methods inherited from interface org.scijava.Versioned

getVersion

Method Detail

run

void run(Object code,
         Object... args)
  throws InvocationTargetException

Executes the code identified by the given object, passing the specified arguments as inputs.

Throws:

InvocationTargetException

run

void run(Object code,
         Map<String,Object> inputMap)
  throws InvocationTargetException

Executes the code identified by the given object, passing the arguments in the specified map as inputs.

Throws:

InvocationTargetException

getType

default Class<Object> getType()

Description copied from interface: Typed

Gets the type associated with the object.

Specified by:

getType in interface Typed<Object>