BeanShell (vassal-app 3.4.13 API)

java.lang.Object

VASSAL.script.BeanShell

public class BeanShell
extends Object

Class encapsulating BeanShell support in Vassal

Field Summary

Fields

Modifier and Type Field Description

static String FALSE

protected ScriptInterpreter globalInterpreter

protected static String INIT_SCRIPT

static String TRUE
Constructor Summary

Constructors

Constructor Description

BeanShell()

Method Summary

Modifier and Type	Method	Description
`CompileResult`	`compile(Reader in)`
`void`	`executeActionScript(String scriptName)`	Execute a Script named in a component DoAction or trait DoAction.
`bsh.NameSpace`	`getGlobalNameSpace()`	Return the Vassal shared NameSpace
`static BeanShell`	`getInstance()`
`void`	`init()`
`static boolean`	`validateExpression(String expression)`	Parse and validate a single expression or script.
`static Object`	`wrap(String value)`	Convert a String value into a wrapped primitive object if possible.

Methods inherited from class java.lang.Object

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

Field Details
- TRUE
  
  public static final String TRUE
  
  See Also:
  
  Constant Field Values
- FALSE
  
  public static final String FALSE
  
  See Also:
  
  Constant Field Values
- INIT_SCRIPT
  
  protected static final String INIT_SCRIPT
  
  See Also:
  
  Constant Field Values
- globalInterpreter
  
  protected ScriptInterpreter globalInterpreter
Constructor Details
- BeanShell
  
  public BeanShell()
Method Details
- getInstance
  
  public static BeanShell getInstance()
- init
  
  public void init()
- compile
  
  public CompileResult compile(Reader in)
- getGlobalNameSpace
  
  public bsh.NameSpace getGlobalNameSpace()
  
  Return the Vassal shared NameSpace
  
  Returns:
  
  Global NameSpace
- executeActionScript
  
  public void executeActionScript(String scriptName)
  
  Execute a Script named in a component DoAction or trait DoAction. Action Scripts take no parameters and return no value.
  
  Parameters:
  
  scriptName - Script name
- validateExpression
  
  public static boolean validateExpression(String expression)
  
  Parse and validate a single expression or script. No evaluation or checking for undefined variables
  
  Parameters:
  
  expression - Expression to validate
- wrap
  
  public static Object wrap(String value)
  
  Convert a String value into a wrapped primitive object if possible.
  
  Parameters:
  
  value - Value to Wrap
  
  Returns:
  
  wrapped value