bsh
Class BshMethod

java.lang.Object
  bsh.BshMethod

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

DelayedEvalBshMethod

public class BshMethod

extends java.lang.Object

implements java.io.Serializable

This represents an instance of a bsh method declaration in a particular namespace. This is a thin wrapper around the BSHMethodDeclaration with a pointer to the declaring namespace.

When a method is located in a subordinate namespace or invoked from an arbitrary namespace it must nontheless execute with its 'super' as the context in which it was declared.

See Also:

Serialized Form

Field Summary

(package private) NameSpace	declaringNameSpace
(package private) BSHBlock	methodBody
(package private) Modifiers	modifiers

Constructor Summary

(package private)	BshMethod(BSHMethodDeclaration method, NameSpace declaringNameSpace, Modifiers modifiers)
(package private)	BshMethod(java.lang.reflect.Method method, java.lang.Object object)
(package private)	BshMethod(java.lang.String name, java.lang.Class returnType, java.lang.String[] paramNames, java.lang.Class[] paramTypes, BSHBlock methodBody, NameSpace declaringNameSpace, Modifiers modifiers)

Method Summary

Modifiers	getModifiers()
java.lang.String	getName()
java.lang.String[]	getParameterNames()
java.lang.Class[]	getParameterTypes() Get the argument types of this method.
java.lang.Class	getReturnType() Get the return type of the method.
boolean	hasModifier(java.lang.String name)
java.lang.Object	invoke(java.lang.Object[] argValues, Interpreter interpreter) Invoke the declared method with the specified arguments and interpreter reference.
java.lang.Object	invoke(java.lang.Object[] argValues, Interpreter interpreter, CallStack callstack, SimpleNode callerInfo) Invoke the declared method with the specified arguments, interpreter reference, and callstack.
(package private) java.lang.Object	invoke(java.lang.Object[] argValues, Interpreter interpreter, CallStack callstack, SimpleNode callerInfo, boolean overrideNameSpace) Invoke the bsh method with the specified args, interpreter ref, and callstack.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

declaringNameSpace

NameSpace declaringNameSpace

modifiers

Modifiers modifiers

methodBody

BSHBlock methodBody

Constructor Detail

BshMethod

BshMethod(BSHMethodDeclaration method,
          NameSpace declaringNameSpace,
          Modifiers modifiers)

BshMethod

BshMethod(java.lang.String name,
          java.lang.Class returnType,
          java.lang.String[] paramNames,
          java.lang.Class[] paramTypes,
          BSHBlock methodBody,
          NameSpace declaringNameSpace,
          Modifiers modifiers)

BshMethod

BshMethod(java.lang.reflect.Method method,
          java.lang.Object object)

Method Detail

getParameterTypes

public java.lang.Class[] getParameterTypes()

Get the argument types of this method. loosely typed (untyped) arguments will be represented by null argument types.

getParameterNames

public java.lang.String[] getParameterNames()

getReturnType

public java.lang.Class getReturnType()

Get the return type of the method.

Returns:

Returns null for a loosely typed return value, Void.TYPE for a void return type, or the Class of the type.

getModifiers

public Modifiers getModifiers()

getName

public java.lang.String getName()

invoke

public java.lang.Object invoke(java.lang.Object[] argValues,
                               Interpreter interpreter)
                        throws EvalError

Invoke the declared method with the specified arguments and interpreter reference. This is the simplest form of invoke() for BshMethod intended to be used in reflective style access to bsh scripts.

Throws:

EvalError

invoke

public java.lang.Object invoke(java.lang.Object[] argValues,
                               Interpreter interpreter,
                               CallStack callstack,
                               SimpleNode callerInfo)
                        throws EvalError

Invoke the declared method with the specified arguments, interpreter reference, and callstack.

Note: this form of invoke() uses a null Node for the caller and a null node for the CallStack. This method is for scripts performing relective style access to scripted methods. public Object invoke( Object[] argValues, Interpreter interpreter, CallStack callstack ) throws EvalError { return invoke( argValues, interpreter, callstack, null, false ); }

Throws:

EvalError

invoke

java.lang.Object invoke(java.lang.Object[] argValues,
                        Interpreter interpreter,
                        CallStack callstack,
                        SimpleNode callerInfo,
                        boolean overrideNameSpace)
                  throws EvalError

Invoke the bsh method with the specified args, interpreter ref, and callstack. callerInfo is the node representing the method invocation It is used primarily for debugging in order to provide access to the text of the construct that invoked the method through the namespace.

Parameters:

callerInfo - is the BeanShell AST node representing the method invocation. It is used to print the line number and text of errors in EvalError exceptions. If the node is null here error messages may not be able to point to the precise location and text of the error.

callstack - is the callstack. If callstack is null a new one will be created with the declaring namespace of the method on top of the stack (i.e. it will look for purposes of the method invocation like the method call occurred in the declaring (enclosing) namespace in which the method is defined).

overrideNameSpace - When true the method is executed in the namespace on the top of the stack instead of creating its own local namespace. This allows it to be used in constructors.

Throws:

EvalError

hasModifier

public boolean hasModifier(java.lang.String name)

toString

public java.lang.String toString()