org.apache.batik.script

Interface Interpreter

public interface Interpreter extends Localizable

An hight level interface that represents an interpreter engine of a particular scripting language.
Method Summary
voidbindObject(String name, Object object)
This method should register a particular Java Object in the environment of the interpreter.
voiddispose()
This method can dispose resources used by the interpreter when it is no longer used.
Objectevaluate(Reader scriptreader, String description)
This method should evaluate a piece of script associated to a given description.
Objectevaluate(Reader scriptreader)
This method should evaluate a piece of script.
Objectevaluate(String script)
This method should evaluate a piece of script using a String instead of a Reader.
voidsetOut(Writer output)
This method should change the output Writer that will be used when output function of the scripting langage is used.

Method Detail

bindObject

public 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

dispose

public 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.

evaluate

public Object evaluate(Reader scriptreader, String description)
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

evaluate

public Object evaluate(Reader scriptreader)
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

evaluate

public Object evaluate(String script)
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

setOut

public 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.

Copyright B) 2008 Apache Software Foundation. All Rights Reserved.