org.apache.bsf.engines.javascript

Class JavaScriptEngine

java.lang.Object

org.apache.bsf.util.BSFEngineImpl

org.apache.bsf.engines.javascript.JavaScriptEngine

All Implemented Interfaces:

java.beans.PropertyChangeListener, java.util.EventListener, BSFEngine

public class JavaScriptEngine
extends BSFEngineImpl

This is the interface to Netscape's Rhino (JavaScript) from the Bean Scripting Framework.

The original version of this code was first written by Adam Peller for use in LotusXSL. Sanjiva took his code and adapted it for BSF.

Author:

Adam Peller , Sanjiva Weerawarana, Matthew J. Duftler, Norris Boyd

Field Summary

Fields inherited from class org.apache.bsf.util.BSFEngineImpl

classLoader, classPath, dbgmgr, declaredBeans, lang, mgr, tempDir

Constructor Summary

Constructors

Constructor and Description
JavaScriptEngine()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	call(java.lang.Object object, java.lang.String method, java.lang.Object[] args) Return an object from an extension.
void	declareBean(BSFDeclaredBean bean) Declare a bean after the engine has been started.
void	disconnectedDebuggerNotify() Basic engines are not supporting breakpoints for the meaning and support is something that is language-specific.
java.lang.Object	eval(java.lang.String source, int lineNo, int columnNo, java.lang.Object oscript) This is used by an application to evaluate a string containing some expression.
java.lang.Object	getSpecificDebuggingInterface() By default, an engine does not support debugging.
void	initialize(BSFManager mgr, java.lang.String lang, java.util.Vector declaredBeans) initialize the engine.
void	placeBreakpointAtLine(int brkptid, java.lang.String docname, int lineno)
void	placeBreakpointAtOffset(int brkptid, java.lang.String docname, int offset)
void	removeBreakpoint(java.lang.String docname, int brkptid)
void	setEntryExit(java.lang.String docname, boolean on)
void	undeclareBean(BSFDeclaredBean bean) Undeclare a previously declared bean.

Methods inherited from class org.apache.bsf.util.BSFEngineImpl

apply, compileApply, compileExpr, compileScript, exec, propertyChange, terminate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JavaScriptEngine

public JavaScriptEngine()

Method Detail

disconnectedDebuggerNotify

public void disconnectedDebuggerNotify()

Description copied from class: BSFEngineImpl

Basic engines are not supporting breakpoints for the meaning and support is something that is language-specific.

Specified by:

disconnectedDebuggerNotify in interface BSFEngine

Overrides:

disconnectedDebuggerNotify in class BSFEngineImpl

placeBreakpointAtLine

public void placeBreakpointAtLine(int brkptid,
                         java.lang.String docname,
                         int lineno)
                           throws BSFException

Specified by:

placeBreakpointAtLine in interface BSFEngine

Overrides:

placeBreakpointAtLine in class BSFEngineImpl

Throws:

BSFException

placeBreakpointAtOffset

public void placeBreakpointAtOffset(int brkptid,
                           java.lang.String docname,
                           int offset)
                             throws BSFException

Specified by:

placeBreakpointAtOffset in interface BSFEngine

Overrides:

placeBreakpointAtOffset in class BSFEngineImpl

Throws:

BSFException

removeBreakpoint

public void removeBreakpoint(java.lang.String docname,
                    int brkptid)
                      throws BSFException

Specified by:

removeBreakpoint in interface BSFEngine

Overrides:

removeBreakpoint in class BSFEngineImpl

Throws:

BSFException

setEntryExit

public void setEntryExit(java.lang.String docname,
                boolean on)
                  throws BSFException

Specified by:

setEntryExit in interface BSFEngine

Overrides:

setEntryExit in class BSFEngineImpl

Throws:

BSFException

call

public java.lang.Object call(java.lang.Object object,
                    java.lang.String method,
                    java.lang.Object[] args)
                      throws BSFException

Return an object from an extension.

Parameters:

object - Object on which to make the call (ignored).

method - The name of the method to call.

args - an array of arguments to be passed to the extension, which may be either Vectors of Nodes, or Strings.

Throws:

BSFException - if anything goes wrong while eval'ing a BSFException is thrown. The reason indicates the problem.

declareBean

public void declareBean(BSFDeclaredBean bean)
                 throws BSFException

Description copied from interface: BSFEngine

Declare a bean after the engine has been started. Declared beans are beans that are named and which the engine must make available to the scripts it runs in the most first class way possible.

Specified by:

declareBean in interface BSFEngine

Overrides:

declareBean in class BSFEngineImpl

Parameters:

bean - the bean to declare

Throws:

BSFException - if the engine cannot do this operation

eval

public java.lang.Object eval(java.lang.String source,
                    int lineNo,
                    int columnNo,
                    java.lang.Object oscript)
                      throws BSFException

This is used by an application to evaluate a string containing some expression.

Parameters:

source - (context info) the source of this expression (e.g., filename)

lineNo - (context info) the line number in source for expr

columnNo - (context info) the column number in source for expr

oscript - the expression to evaluate

Throws:

BSFException - if anything goes wrong while eval'ing a BSFException is thrown. The reason indicates the problem.

getSpecificDebuggingInterface

public java.lang.Object getSpecificDebuggingInterface()

Description copied from class: BSFEngineImpl

By default, an engine does not support debugging. Subclasses will need to redefine this method in order to provide debuggers with their language-specific interface for debugging.

Specified by:

getSpecificDebuggingInterface in interface BSFEngine

Overrides:

getSpecificDebuggingInterface in class BSFEngineImpl

initialize

public void initialize(BSFManager mgr,
              java.lang.String lang,
              java.util.Vector declaredBeans)
                throws BSFException

initialize the engine. put the manager into the context -> manager map hashtable too.

Specified by:

initialize in interface BSFEngine

Overrides:

initialize in class BSFEngineImpl

Parameters:

mgr - The BSFManager that's hosting this engine.

lang - Language string which this engine is handling.

declaredBeans - Vector of BSFDeclaredObject containing beans that should be declared into the language runtime at init time as best as possible.

Throws:

BSFException - if anything goes wrong while init'ing a BSFException is thrown. The reason indicates the problem.

undeclareBean

public void undeclareBean(BSFDeclaredBean bean)
                   throws BSFException

Description copied from interface: BSFEngine

Undeclare a previously declared bean.

Specified by:

undeclareBean in interface BSFEngine

Overrides:

undeclareBean in class BSFEngineImpl

Parameters:

bean - the bean to undeclare

Throws:

BSFException - if the engine cannot do this operation