org.apache.batik.script

Interface Interpreter

All Superinterfaces:

org.apache.batik.i18n.Localizable

All Known Implementing Classes:

JaclInterpreter, JPythonInterpreter

public interface Interpreter
extends org.apache.batik.i18n.Localizable

A high level interface that represents an interpreter engine for a particular scripting language.

Version:

$Id: Interpreter.java 1733416 2016-03-03 07:07:13Z gadams $

Author:

Christophe Jolif

Method Summary

Methods

Modifier and Type	Method and Description
void	bindObject(String name, Object object) This method should register a particular Java Object in the environment of the interpreter.
void	dispose() This method can dispose resources used by the interpreter when it is no longer used.
Object	evaluate(Reader scriptreader) This method should evaluate a piece of script.
Object	evaluate(Reader scriptreader, String description) This method should evaluate a piece of script associated to a given description.
Object	evaluate(String script) This method should evaluate a piece of script using a String instead of a Reader.
String[]	getMimeTypes() Returns the content types of the scripting languages this interpreter handles.
void	setOut(Writer output) This method should change the output Writer that will be used when output function of the scripting langage is used.

Methods inherited from interface org.apache.batik.i18n.Localizable

formatMessage, getLocale, setLocale

Method Detail

getMimeTypes

String[] getMimeTypes()

Returns the content types of the scripting languages this interpreter handles.

evaluate

Object evaluate(Reader scriptreader,
              String description)
                throws InterpreterException,
                       IOException

This method should evaluate a piece of script associated to a given description.

Parameters:

scriptreader - a java.io.Reader on the piece of script

description - description which can be later used (e.g., for error messages).

Returns:

if no exception is thrown during the call, should return the value of the last expression evaluated in the script

Throws:

InterpreterException

IOException

evaluate

Object evaluate(Reader scriptreader)
                throws InterpreterException,
                       IOException

This method should evaluate a piece of script.

Parameters:

scriptreader - a java.io.Reader on the piece of script

Returns:

if no exception is thrown during the call, should return the value of the last expression evaluated in the script

Throws:

InterpreterException

IOException

evaluate

Object evaluate(String script)
                throws InterpreterException

This method should evaluate a piece of script using a String instead of a Reader. This usually allows do easily do some caching.

Parameters:

script - the piece of script

Returns:

if no exception is thrown during the call, should return the value of the last expression evaluated in the script

Throws:

InterpreterException

bindObject

void bindObject(String name,
              Object object)

This method should register a particular Java Object in the environment of the interpreter.

Parameters:

name - the name of the script object to create

object - the Java object

setOut

void setOut(Writer output)

This method should change the output Writer that will be used when output function of the scripting langage is used.

Parameters:

output - the new out Writer.

dispose

void dispose()

This method can dispose resources used by the interpreter when it is no longer used. Be careful, you SHOULD NOT use this interpreter instance after calling this method.