Package com.storedobject.common

Class Script

java.lang.Object

com.storedobject.common.Script

public class Script
extends Object

A simple wrapper class to execute scripting languages from Java. If GraalVM is used as the JVM, multiple languages can be made available. Otherwise, at least JavaScript would be available.

Author:

Syam

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Script.Language	Supported languages.

Constructor Summary

Constructors

Constructor	Description
Script()	Constructor.
Script(Script.Language language)	Constructor.
Script(Script.Language language, String script)	Constructor.
Script(String script)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addScript(String script)	Append more to the existing script.
void	clear()	Clear the current script and variables.
Object	evaluate()	Evaluate script which was already set.
Object	evaluate(Reader script)	Evaluate script supplied by a Reader.
Object	evaluate(String script)	Evaluate script.
Object	get(String variable)	Get current value of a variable that was set.
boolean	isAvailable()	Check whether the language is available or not.
void	set(String variable, Object value)	Set a value for the variable in the script.
void	setScript(String script)	Set the script for execution.

Methods inherited from class java.lang.Object

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

Constructor Details

Script

public Script()

Constructor. Default language is JavaScript.

Script

public Script(String script)

Constructor. Default language is JavaScript.

Parameters:

script - Script to set for execution.

Script

public Script(Script.Language language)

Constructor.

Parameters:

language - Language.

Script

public Script(Script.Language language,
 String script)

Constructor.

Parameters:

language - Language.

script - Script to set for execution.

Method Details

isAvailable

public boolean isAvailable()

Check whether the language is available or not.

Returns:

True if the requested language is available.

setScript

public void setScript(String script)

Set the script for execution.

Parameters:

script - Script.

addScript

public void addScript(String script)

Append more to the existing script.

Parameters:

script - Script to add.

clear

public void clear()

Clear the current script and variables.

set

public void set(String variable,
 Object value)

Set a value for the variable in the script.

Parameters:

variable - Variable to set.

value - Value to set.

get

public Object get(String variable)

Get current value of a variable that was set.

Parameters:

variable - Variable.

Returns:

Value of the variable. Will return null if variable was never set.

evaluate

public Object evaluate(String script)
                throws SOException

Evaluate script.

Parameters:

script - Script to evaluate. (Script that was set earlier, if any, will be cleared).

Returns:

Value returned by the scripting engine.

Throws:

SOException - Error if any from the scripting engine.

evaluate

public Object evaluate()
                throws SOException

Evaluate script which was already set.

Returns:

Value returned by the scripting engine.

Throws:

SOException - Error if any from the scripting engine.

evaluate

public Object evaluate(Reader script)
                throws SOException

Evaluate script supplied by a Reader.

Parameters:

script - Reader to read the script from. (Script that was set earlier, if any, will be cleared).

Returns:

Value returned by the scripting engine.

Throws:

SOException - Error if any from the scripting engine.