bsh

Class NameSpace

java.lang.Object

bsh.NameSpace

All Implemented Interfaces:

BshClassManager.Listener, NameSource, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

ExternalNameSpace

public class NameSpace
extends java.lang.Object
implements java.io.Serializable, BshClassManager.Listener, NameSource, java.lang.Cloneable

A namespace in which methods, variables, and imports (class names) live. This is package public because it is used in the implementation of some bsh commands. However for normal use you should be using methods on bsh.Interpreter to interact with your scripts.

A bsh.This object is a thin layer over a NameSpace that associates it with an Interpreter instance. Together they comprise a Bsh scripted object context.

Note: Dropping support for JDK 1.1. in favour of Collections Note: This class has gotten too big. It should be broken down a bit.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface bsh.NameSource

NameSource.Listener

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.String>	importedClasses The imported classes.
static NameSpace	JAVACODE The Constant JAVACODE.

Constructor Summary

Constructors

Constructor and Description
NameSpace(NameSpace parent, BshClassManager classManager, java.lang.String name) Instantiates a new name space.
NameSpace(NameSpace parent, java.lang.String name) Instantiates a new name space.
NameSpace(java.lang.String name) Instantiates a new name space for name.
NameSpace(java.lang.String name, BshClassManager classManager) Instantiates a new name space for name with class manager.

Method Summary

Modifier and Type	Method and Description
void	addNameSourceListener(NameSource.Listener listener) Implements NameSource Add a listener who is notified upon changes to names in this space.
void	classLoaderChanged() Clear all cached classes and names.
void	clear() Clear all variables, methods, and imports from this namespace.
protected Variable	createVariable(java.lang.String name, java.lang.Class<?> type, bsh.LHS lhs) Creates the variable.
protected Variable	createVariable(java.lang.String name, java.lang.Class<?> type, java.lang.Object value, Modifiers mods) Creates the variable.
protected Variable	createVariable(java.lang.String name, java.lang.Object value, Modifiers mods) Creates the variable.
void	doSuperImport() Perform "import *;" causing the entire classpath to be mapped.
java.lang.Object	get(java.lang.String name, Interpreter interpreter) Resolve name to an object through this namespace.
java.lang.String[]	getAllNames() Implements NameSource.
protected void	getAllNamesAux(java.util.List<java.lang.String> vec) Helper for implementing NameSource.
java.lang.Class<?>	getClass(java.lang.String name) Load a class through this namespace taking into account imports.
BshClassManager	getClassManager() Gets the class manager.
java.lang.Object	getCommand(java.lang.String name, java.lang.Class<?>[] argTypes, Interpreter interpreter) A command is a scripted method or compiled command class implementing a specified method signature.
Variable[]	getDeclaredVariables()
This	getGlobal(Interpreter declaringInterpreter) Get the top level namespace or this namespace if we are the top.
protected BshMethod	getImportedMethod(java.lang.String name, java.lang.Class<?>[] sig) Gets the imported method.
protected Variable	getImportedVar(java.lang.String name) Gets the imported var.
int	getInvocationLine() Gets the invocation line.
java.lang.String	getInvocationText() Gets the invocation text.
BshMethod	getMethod(java.lang.String name, java.lang.Class<?>[] sig) Gets the method.
BshMethod	getMethod(java.lang.String name, java.lang.Class<?>[] sig, boolean declaredOnly) Get the bsh method matching the specified signature declared in this name space or a parent.
java.lang.String[]	getMethodNames() Get the names of methods declared in this namespace.
BshMethod[]	getMethods() Get the methods defined in this namespace.
java.lang.String	getName() The name of this namespace.
NameSpace	getParent() Get the parent namespace.
This	getSuper(Interpreter declaringInterpreter) Get the parent namespace' This reference or this namespace' This reference if we are the top.
This	getThis(Interpreter declaringInterpreter) A This object is a thin layer over a namespace, comprising a bsh object context.
java.lang.Object	getVariable(java.lang.String name) Get the specified variable in this namespace or a parent namespace.
java.lang.Object	getVariable(java.lang.String name, boolean recurse) Get the specified variable in this namespace.
protected Variable	getVariableImpl(java.lang.String name, boolean recurse) Locate a variable and return the Variable object with optional recursion through parent name spaces.
java.lang.String[]	getVariableNames() Get the names of variables defined in this namespace.
java.lang.Object	getVariableOrProperty(java.lang.String name, Interpreter interp) Get the specified variable or property in this namespace or a parent namespace.
Variable[]	getVariables() Get the variables defined in this namespace.
static java.lang.Class<?>	identifierToClass(ClassIdentifier ci) This is a helper method for working inside of bsh scripts and commands.
void	importClass(java.lang.String name) Import a class name.
void	importCommands(java.lang.String name) Import scripted or compiled BeanShell commands in the following package in the classpath.
void	importObject(java.lang.Object obj) Import a compiled Java object's methods and variables into this namespace.
void	importPackage(java.lang.String name) subsequent imports override earlier ones.
void	importStatic(java.lang.Class<?> clas) Import static.
protected java.lang.Object	invokeCommand(java.lang.String commandName, java.lang.Object[] args, Interpreter interpreter, CallStack callstack, Node callerInfo) Invoke an imported command scoped by namespace hierarchy.
protected java.lang.Object	invokeCommand(java.lang.String commandName, java.lang.Object[] args, Interpreter interpreter, CallStack callstack, Node callerInfo, boolean ignoreInvoke) Invoke an imported command scoped by namespace hierarchy.
protected java.lang.Object	invokeDefaultInvokeMethod(java.lang.String commandName, java.lang.Object[] args, Interpreter interpreter, CallStack callstack, Node callerInfo, boolean[] outHasMethod) Invoke the default invoke method if found in the namespace, Updates the outHasMethod array index 0 by reference, if false then method was not found and the return result is meaningless.
java.lang.Object	invokeMethod(java.lang.String methodName, java.lang.Object[] args, Interpreter interpreter) Invoke a method in this namespace with the specified args and interpreter reference.
java.lang.Object	invokeMethod(java.lang.String methodName, java.lang.Object[] args, Interpreter interpreter, CallStack callstack, Node callerInfo) This method simply delegates to This.invokeMethod();.
boolean	isChildOf(NameSpace parent) Check if this namespace is a child of the given namespace.
void	loadDefaultImports() Import standard packages.
void	nameSpaceChanged() Clear all cached classes and names.
void	prune() Used for serialization.
Variable	setLocalVariable(java.lang.String name, java.lang.Object value, boolean strictJava) Set a variable explicitly in the local scope.
void	setMethod(BshMethod method) Dissallow static vars outside of a class.
void	setName(java.lang.String name) Sets the name.
void	setParent(NameSpace parent) Sets the parent.
void	setTypedVariable(java.lang.String name, java.lang.Class<?> type, java.lang.Object value, boolean isFinal) Deprecated. See #setTypedVariable(String, Class, Object, Modifiers)
void	setTypedVariable(java.lang.String name, java.lang.Class<?> type, java.lang.Object value, Modifiers modifiers) Declare a variable in the local scope and set its initial value.
void	setVariable(java.lang.String name, java.lang.Object value, boolean strictJava) Set the variable through this namespace.
protected void	setVariableImpl(Variable var)
void	setVariableOrProperty(java.lang.String name, java.lang.Object value, boolean strictJava) Sets a variable or property.
java.lang.String	toString()
void	unsetVariable(java.lang.String name) Remove the variable from the namespace.
protected java.lang.Object	unwrapVariable(Variable var) Unwrap a variable to its value.

Methods inherited from class java.lang.Object

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

Field Detail

JAVACODE

public static final NameSpace JAVACODE

The Constant JAVACODE.

importedClasses

protected java.util.Map<java.lang.String,java.lang.String> importedClasses

The imported classes.

Constructor Detail

NameSpace

public NameSpace(NameSpace parent,
                 java.lang.String name)

Instantiates a new name space.

Parameters:

parent - the parent

name - the name

NameSpace

public NameSpace(java.lang.String name)

Instantiates a new name space for name.

Parameters:

name - the name

NameSpace

public NameSpace(java.lang.String name,
                 BshClassManager classManager)

Instantiates a new name space for name with class manager.

Parameters:

name - the name

classManager - the class manager

NameSpace

public NameSpace(NameSpace parent,
                 BshClassManager classManager,
                 java.lang.String name)

Instantiates a new name space.

Parameters:

parent - the parent

classManager - the class manager

name - the name

Method Detail

setName

public void setName(java.lang.String name)

Sets the name.

Parameters:

name - the new name

getName

public java.lang.String getName()

The name of this namespace. If the namespace is a method body namespace then this is the name of the method. If it's a class or class instance then it's the name of the class.

Returns:

the name

get

public java.lang.Object get(java.lang.String name,
                            Interpreter interpreter)
                     throws UtilEvalError

Resolve name to an object through this namespace.

Parameters:

name - the name

interpreter - the interpreter

Returns:

the object

Throws:

UtilEvalError - the util eval error

setVariable

public void setVariable(java.lang.String name,
                        java.lang.Object value,
                        boolean strictJava)
                 throws UtilEvalError

Set the variable through this namespace.

Note: this method is primarily intended for use internally. If you use this method outside of the bsh package and wish to set variables with primitive values you will have to wrap them using bsh.Primitive.

Parameters:

name - the name

value - the value

strictJava - specifies whether strict java rules are applied.

Throws:

UtilEvalError - the util eval error

See Also:

Setting a new variable (which didn't exist before) or removing a variable causes a namespace change.

setLocalVariable

public Variable setLocalVariable(java.lang.String name,
                                 java.lang.Object value,
                                 boolean strictJava)
                          throws UtilEvalError

Set a variable explicitly in the local scope.

Parameters:

name - the name

value - the value

strictJava - the strict java

Returns:

the variable

Throws:

UtilEvalError - the util eval error

setVariableOrProperty

public void setVariableOrProperty(java.lang.String name,
                                  java.lang.Object value,
                                  boolean strictJava)
                           throws UtilEvalError

Sets a variable or property. See "setVariable" for rules regarding scoping.

We first check for the existence of the variable. If it exists, we set it. If the variable does not exist we look for a property. If the property exists and is writable we set it. Finally, if neither the variable or the property exist, we create a new variable.

Parameters:

name - the name

value - the value

strictJava - specifies whether strict java rules are applied.

Throws:

UtilEvalError - the util eval error

createVariable

protected Variable createVariable(java.lang.String name,
                                  java.lang.Object value,
                                  Modifiers mods)
                           throws UtilEvalError

Creates the variable.

Parameters:

name - the name

value - the value

mods - the mods

Returns:

the variable

Throws:

UtilEvalError - the util eval error

createVariable

protected Variable createVariable(java.lang.String name,
                                  java.lang.Class<?> type,
                                  java.lang.Object value,
                                  Modifiers mods)
                           throws UtilEvalError

Creates the variable.

Parameters:

name - the name

type - the type

value - the value

mods - the mods

Returns:

the variable

Throws:

UtilEvalError - the util eval error

createVariable

protected Variable createVariable(java.lang.String name,
                                  java.lang.Class<?> type,
                                  bsh.LHS lhs)
                           throws UtilEvalError

Creates the variable.

Parameters:

name - the name

type - the type

lhs - the lhs

Returns:

the variable

Throws:

UtilEvalError - the util eval error

unsetVariable

public void unsetVariable(java.lang.String name)

Remove the variable from the namespace.

Parameters:

name - the name

getVariableNames

public java.lang.String[] getVariableNames()

Get the names of variables defined in this namespace. (This does not show variables in parent namespaces).

getVariables

public Variable[] getVariables()

Get the variables defined in this namespace. (This does not show variables in parent namespaces).

getMethodNames

public java.lang.String[] getMethodNames()

Get the names of methods declared in this namespace. (This does not include methods in parent namespaces).

getMethods

public BshMethod[] getMethods()

Get the methods defined in this namespace. (This does not show methods in parent namespaces). Note: This will probably be renamed getDeclaredMethods()

Returns:

the methods

getParent

public NameSpace getParent()

Get the parent namespace. Note: this isn't quite the same as getSuper(). getSuper() returns 'this' if we are at the root namespace.

Returns:

the parent

isChildOf

public boolean isChildOf(NameSpace parent)

Check if this namespace is a child of the given namespace.

Parameters:

parent - the possible parent

Returns:

true if this is child of parent

getSuper

public This getSuper(Interpreter declaringInterpreter)

Get the parent namespace' This reference or this namespace' This reference if we are the top.

Parameters:

declaringInterpreter - the declaring interpreter

Returns:

the super

getGlobal

public This getGlobal(Interpreter declaringInterpreter)

Get the top level namespace or this namespace if we are the top. Note: this method should probably return type bsh.This to be consistent with getThis();

Parameters:

declaringInterpreter - the declaring interpreter

Returns:

the global

getThis

public This getThis(Interpreter declaringInterpreter)

A This object is a thin layer over a namespace, comprising a bsh object context. It handles things like the interface types the bsh object supports and aspects of method invocation on it.

The declaringInterpreter is here to support callbacks from Java through generated proxies. The scripted object "remembers" who created it for things like printing messages and other per-interpreter phenomenon when called externally from Java.

Parameters:

declaringInterpreter - the declaring interpreter

Returns:

the this Note: we need a singleton here so that things like 'this == this' work (and probably a good idea for speed). Caching a single instance here seems technically incorrect, considering the declaringInterpreter could be different under some circumstances. (Case: a child interpreter running a source() / eval() command). However the effect is just that the main interpreter that executes your script should be the one involved in call-backs from Java. I do not know if there are corner cases where a child interpreter would be the first to use a This reference in a namespace or if that would even cause any problems if it did... We could do some experiments to find out... and if necessary we could cache on a per interpreter basis if we had weak references... We might also look at skipping over child interpreters and going to the parent for the declaring interpreter, so we'd be sure to get the top interpreter.

getClassManager

public BshClassManager getClassManager()

Gets the class manager.

Returns:

the class manager

prune

public void prune()

Used for serialization.

setParent

public void setParent(NameSpace parent)

Sets the parent.

Parameters:

parent - the new parent

getVariableOrProperty

public java.lang.Object getVariableOrProperty(java.lang.String name,
                                              Interpreter interp)
                                       throws UtilEvalError

Get the specified variable or property in this namespace or a parent namespace.

We first search for a variable name, and then a property.

Parameters:

name - the name

interp - the interp

Returns:

The variable or property value or Primitive.VOID if neither is defined.

Throws:

UtilEvalError - the util eval error

getVariable

public java.lang.Object getVariable(java.lang.String name)
                             throws UtilEvalError

Get the specified variable in this namespace or a parent namespace.

Note: this method is primarily intended for use internally. If you use this method outside of the bsh package you will have to use Primitive.unwrap() to get primitive values.

Parameters:

name - the name

Returns:

The variable value or Primitive.VOID if it is not defined.

Throws:

UtilEvalError - the util eval error

See Also:

Primitive.unwrap(Object)

getVariable

public java.lang.Object getVariable(java.lang.String name,
                                    boolean recurse)
                             throws UtilEvalError

Get the specified variable in this namespace.

Parameters:

name - the name

recurse - If recurse is true then we recursively search through parent namespaces for the variable.

Note: this method is primarily intended for use internally. If you use this method outside of the bsh package you will have to use Primitive.unwrap() to get primitive values.

Returns:

The variable value or Primitive.VOID if it is not defined.

Throws:

UtilEvalError - the util eval error

See Also:

Primitive.unwrap(Object)

getVariableImpl

protected Variable getVariableImpl(java.lang.String name,
                                   boolean recurse)
                            throws UtilEvalError

Locate a variable and return the Variable object with optional recursion through parent name spaces.

If this namespace is static, return only static variables.

Parameters:

name - the name

recurse - the recurse

Returns:

the Variable value or null if it is not defined

Throws:

UtilEvalError - the util eval error

setVariableImpl

protected void setVariableImpl(Variable var)

getDeclaredVariables

public Variable[] getDeclaredVariables()

unwrapVariable

protected java.lang.Object unwrapVariable(Variable var)
                                   throws UtilEvalError

Unwrap a variable to its value.

Parameters:

var - the var

Returns:

return the variable value. A null var is mapped to Primitive.VOID

Throws:

UtilEvalError - the util eval error

setTypedVariable

@Deprecated
public void setTypedVariable(java.lang.String name,
                                         java.lang.Class<?> type,
                                         java.lang.Object value,
                                         boolean isFinal)
                                  throws UtilEvalError

Deprecated. See #setTypedVariable(String, Class, Object, Modifiers)

Sets the typed variable.

Parameters:

name - the name

type - the type

value - the value

isFinal - the is final

Throws:

UtilEvalError - the util eval error

setTypedVariable

public void setTypedVariable(java.lang.String name,
                             java.lang.Class<?> type,
                             java.lang.Object value,
                             Modifiers modifiers)
                      throws UtilEvalError

Declare a variable in the local scope and set its initial value. Value may be null to indicate that we would like the default value for the variable type. (e.g. 0 for integer types, null for object types). An existing typed variable may only be set to the same type. If an untyped variable of the same name exists it will be overridden with the new typed var. The set will perform a Types.getAssignableForm() on the value if necessary.

Note: this method is primarily intended for use internally. If you use this method outside of the bsh package and wish to set variables with primitive values you will have to wrap them using bsh.Primitive.

Parameters:

name - the name

type - the type

value - If value is null, you'll get the default value for the type

modifiers - may be null

Throws:

UtilEvalError - the util eval error

See Also:

Primitive

setMethod

public void setMethod(BshMethod method)

Dissallow static vars outside of a class.

Parameters:

name - is here just to allow the error message to use it protected void checkVariableModifiers(String name, Modifiers modifiers) throws UtilEvalError { if (modifiers!=null && modifiers.hasModifier("static")) throw new UtilEvalError("Can't declare static variable outside of class: "+name); }

method - the method

Throws:

UtilEvalError - the util eval error Note: this is primarily for internal use.

See Also:

Interpreter.source(String), Interpreter.eval(String)

getMethod

public BshMethod getMethod(java.lang.String name,
                           java.lang.Class<?>[] sig)
                    throws UtilEvalError

Gets the method.

Parameters:

name - the name

sig - the sig

Returns:

the method

Throws:

UtilEvalError - the util eval error

See Also:

getMethod(String, Class [], boolean), getMethod(String, Class [])

getMethod

public BshMethod getMethod(java.lang.String name,
                           java.lang.Class<?>[] sig,
                           boolean declaredOnly)
                    throws UtilEvalError

Get the bsh method matching the specified signature declared in this name space or a parent.

Note: this method is primarily intended for use internally. If you use this method outside of the bsh package you will have to be familiar with BeanShell's use of the Primitive wrapper class.

Parameters:

name - the name

sig - the sig

declaredOnly - if true then only methods declared directly in this namespace will be found and no inherited or imported methods will be visible.

Returns:

the BshMethod or null if not found

Throws:

UtilEvalError - the util eval error

See Also:

Primitive

importClass

public void importClass(java.lang.String name)

Import a class name. Subsequent imports override earlier ones

Parameters:

name - the name

importPackage

public void importPackage(java.lang.String name)

subsequent imports override earlier ones.

Parameters:

name - the name

importCommands

public void importCommands(java.lang.String name)

Import scripted or compiled BeanShell commands in the following package in the classpath. You may use either "/" path or "." package notation. e.g. importCommands("/bsh/commands") or importCommands("bsh.commands") are equivalent. If a relative path style specifier is used then it is made into an absolute path by prepending "/".

Parameters:

name - the name

getCommand

public java.lang.Object getCommand(java.lang.String name,
                                   java.lang.Class<?>[] argTypes,
                                   Interpreter interpreter)
                            throws UtilEvalError

A command is a scripted method or compiled command class implementing a specified method signature. Commands are loaded from the classpath and may be imported using the importCommands() method.

This method searches the imported commands packages for a script or command object corresponding to the name of the method. If it is a script the script is sourced into this namespace and the BshMethod for the requested signature is returned. If it is a compiled class the class is returned. (Compiled command classes implement static invoke() methods).

The imported packages are searched in reverse order, so that later imports take priority. Currently only the first object (script or class) with the appropriate name is checked. If another, overloaded form, is located in another package it will not currently be found. This could be fixed.

Parameters:

name - is the name of the desired command method

argTypes - is the signature of the desired command method.

interpreter - the interpreter

Returns:

a BshMethod, Class, or null if no such command is found.

Throws:

UtilEvalError - if loadScriptedCommand throws UtilEvalError i.e. on errors loading a script that was found

getImportedMethod

protected BshMethod getImportedMethod(java.lang.String name,
                                      java.lang.Class<?>[] sig)
                               throws UtilEvalError

Gets the imported method.

Parameters:

name - the name

sig - the sig

Returns:

the imported method

Throws:

UtilEvalError - the util eval error

getImportedVar

protected Variable getImportedVar(java.lang.String name)
                           throws UtilEvalError

Gets the imported var.

Parameters:

name - the name

Returns:

the imported var

Throws:

UtilEvalError - the util eval error

getClass

public java.lang.Class<?> getClass(java.lang.String name)
                            throws UtilEvalError

Load a class through this namespace taking into account imports. The class search will proceed through the parent namespaces if necessary.

Parameters:

name - the name

Returns:

null if not found.

Throws:

UtilEvalError - the util eval error

getAllNames

public java.lang.String[] getAllNames()

Implements NameSource.

Specified by:

getAllNames in interface NameSource

Returns:

all variable and method names in this and all parent namespaces

getAllNamesAux

protected void getAllNamesAux(java.util.List<java.lang.String> vec)

Helper for implementing NameSource.

Parameters:

vec - the vec

addNameSourceListener

public void addNameSourceListener(NameSource.Listener listener)

Implements NameSource Add a listener who is notified upon changes to names in this space.

Specified by:

addNameSourceListener in interface NameSource

Parameters:

listener - the listener

doSuperImport

public void doSuperImport()
                   throws UtilEvalError

Perform "import *;" causing the entire classpath to be mapped. This can take a while.

Super imports are different than regular imports. They are done in the context of the ClassManager rather than the NameSpace and thus their effects may persist after the NameSpace is released. It seems irregular that named imports are 'local' to the namespace but super imports are 'global' to the class manager but I suppose for performance reasons it is a good idea to scan the super class path only once and store the results.

Throws:

UtilEvalError - the util eval error

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

invokeMethod

public java.lang.Object invokeMethod(java.lang.String methodName,
                                     java.lang.Object[] args,
                                     Interpreter interpreter)
                              throws EvalError

Invoke a method in this namespace with the specified args and interpreter reference. No caller information or call stack is required. The method will appear as if called externally from Java.

Parameters:

methodName - the method name

args - the args

interpreter - the interpreter

Returns:

the object

Throws:

EvalError - the eval error

See Also:

bsh.This.invokeMethod(String methodName, Object [] args, Interpreter interpreter, CallStack callstack, Node callerInfo, boolean)

invokeMethod

public java.lang.Object invokeMethod(java.lang.String methodName,
                                     java.lang.Object[] args,
                                     Interpreter interpreter,
                                     CallStack callstack,
                                     Node callerInfo)
                              throws EvalError

This method simply delegates to This.invokeMethod();.

Parameters:

methodName - the method name

args - the args

interpreter - the interpreter

callstack - the callstack

callerInfo - the caller info

Returns:

the object

Throws:

EvalError - the eval error

See Also:

bsh.This.invokeMethod(String methodName, Object [] args, Interpreter interpreter, CallStack callstack, Node callerInfo)

invokeCommand

protected java.lang.Object invokeCommand(java.lang.String commandName,
                                         java.lang.Object[] args,
                                         Interpreter interpreter,
                                         CallStack callstack,
                                         Node callerInfo)
                                  throws EvalError

Invoke an imported command scoped by namespace hierarchy. When no commands were found attempt to invoke the default invoke method if it is present in the namespace.

Parameters:

commandName - the command name

args - the args

interpreter - the interpreter

callstack - the callstack

callerInfo - the caller info

Returns:

the method return data object

Throws:

EvalError - the eval error

invokeCommand

protected java.lang.Object invokeCommand(java.lang.String commandName,
                                         java.lang.Object[] args,
                                         Interpreter interpreter,
                                         CallStack callstack,
                                         Node callerInfo,
                                         boolean ignoreInvoke)
                                  throws EvalError

Invoke an imported command scoped by namespace hierarchy. Unless ignore invoke is true, when no commands were found attempt to invoke the default invoke method if it is present in the namespace.

Parameters:

commandName - the command name

args - the args

interpreter - the interpreter

callstack - the callstack

callerInfo - the caller info

ignoreInvoke - do not call default invoke if no commands found

Returns:

the method return data object

Throws:

EvalError - the eval error

invokeDefaultInvokeMethod

protected java.lang.Object invokeDefaultInvokeMethod(java.lang.String commandName,
                                                     java.lang.Object[] args,
                                                     Interpreter interpreter,
                                                     CallStack callstack,
                                                     Node callerInfo,
                                                     boolean[] outHasMethod)
                                              throws EvalError

Invoke the default invoke method if found in the namespace, Updates the outHasMethod array index 0 by reference, if false then method was not found and the return result is meaningless.

Parameters:

commandName - the command name

args - the args

interpreter - the interpreter

callstack - the callstack

callerInfo - the caller info

outHasMethod - update array by reference if method found

Returns:

the method return data object

Throws:

EvalError - the eval error

classLoaderChanged

public void classLoaderChanged()

Clear all cached classes and names.

Specified by:

classLoaderChanged in interface BshClassManager.Listener

nameSpaceChanged

public void nameSpaceChanged()

Clear all cached classes and names.

loadDefaultImports

public void loadDefaultImports()

Import standard packages. Currently:

 importClass("bsh.EvalError");
 importClass("bsh.Interpreter");
 importClass("bsh.Capabilities");
 importPackage("java.net");
 importClass("java.util.Map.Entry");
 importPackage("java.util.function");
 importPackage("java.util.stream");
 importPackage("java.util.regex");
 importPackage("java.util");
 importPackage("java.io");
 importPackage("java.lang");
 importClass("bsh.FileReader");
 importPackage("java.math");
 importCommands("/bsh/commands");
 

getInvocationLine

public int getInvocationLine()

Gets the invocation line.

Returns:

the invocation line

getInvocationText

public java.lang.String getInvocationText()

Gets the invocation text.

Returns:

the invocation text

identifierToClass

public static java.lang.Class<?> identifierToClass(ClassIdentifier ci)

This is a helper method for working inside of bsh scripts and commands. In that context it is impossible to see a ClassIdentifier object for what it is. Attempting to access a method on a ClassIdentifier will look like a static method invocation. This method is in NameSpace for convenience (you don't have to import bsh.ClassIdentifier to use it);

Parameters:

ci - the ci

Returns:

the class

clear

public void clear()

Clear all variables, methods, and imports from this namespace. If this namespace is the root, it will be reset to the default imports.

See Also:

loadDefaultImports()

importObject

public void importObject(java.lang.Object obj)

Import a compiled Java object's methods and variables into this namespace. When no scripted method / command or variable is found locally in this namespace method / fields of the object will be checked. Objects are checked in the order of import with later imports taking precedence.

Parameters:

obj - the obj Note: this impor pattern is becoming common... could factor it out into an importedObject List class.

importStatic

public void importStatic(java.lang.Class<?> clas)

Import static.

Parameters:

clas - the clas