de.undercouch.citeproc.script

Interface ScriptRunner

All Superinterfaces:

JsonBuilderFactory

All Known Implementing Classes:

AbstractScriptRunner, JREScriptRunner, V8ScriptRunner

public interface ScriptRunner
extends JsonBuilderFactory

Executes JavaScript scripts

Author:

Michel Kraemer

Method Summary

Modifier and Type	Method and Description
<T> T	callMethod(Object obj, String name, Class<T> resultType, Object... args) Calls an object's method
void	callMethod(Object obj, String name, Object... args) Calls an object's method
<T> T	callMethod(String name, Class<T> resultType, Object... args) Calls a top-level method
void	callMethod(String name, Object... args) Calls a top-level method
<T> T	convert(Object o, Class<T> type) Tries to convert the given object to the given type
void	eval(Reader reader) Executes a script provided by a given reader
String	getName()
String	getVersion()
void	loadScript(URL url) Loads a script from a URL and evaluates it

Methods inherited from interface de.undercouch.citeproc.helper.json.JsonBuilderFactory

createJsonBuilder

Method Detail

getName

String getName()

Returns:

the runner's name

getVersion

String getVersion()

Returns:

the runner's version

loadScript

void loadScript(URL url)
         throws IOException,
                ScriptRunnerException

Loads a script from a URL and evaluates it

Parameters:

url - the script's URL

Throws:

IOException - if the script could not be loaded

ScriptRunnerException - if the script is invalid

eval

void eval(Reader reader)
   throws ScriptRunnerException,
          IOException

Executes a script provided by a given reader

Parameters:

reader - the reader

Throws:

ScriptRunnerException - if the script could not be executed

IOException - if the script could not be read from the reader

callMethod

<T> T callMethod(String name,
                 Class<T> resultType,
                 Object... args)
          throws ScriptRunnerException

Calls a top-level method

Type Parameters:

T - the type of the return value

Parameters:

name - the method's name

resultType - the expected type of the return value

args - the arguments

Returns:

the return value

Throws:

ScriptRunnerException - if the method could not be called

callMethod

void callMethod(String name,
                Object... args)
         throws ScriptRunnerException

Calls a top-level method

Parameters:

name - the method's name

args - the arguments

Throws:

ScriptRunnerException - if the method could not be called

callMethod

<T> T callMethod(Object obj,
                 String name,
                 Class<T> resultType,
                 Object... args)
          throws ScriptRunnerException

Calls an object's method

Type Parameters:

T - the type of the return value

Parameters:

obj - the object

name - the method's name

resultType - the expected type of the return value

args - the arguments

Returns:

the return value

Throws:

ScriptRunnerException - if the method could not be called

callMethod

void callMethod(Object obj,
                String name,
                Object... args)
         throws ScriptRunnerException

Calls an object's method

Parameters:

obj - the object

name - the method's name

args - the arguments

Throws:

ScriptRunnerException - if the method could not be called

convert

<T> T convert(Object o,
              Class<T> type)

Tries to convert the given object to the given type

Type Parameters:

T - the type to convert to

Parameters:

o - the object to convert

type - the type to convert to

Returns:

the converted object