org.jline.reader

Interface ScriptEngine

public interface ScriptEngine

Manage scriptEngine variables, statements and script execution.

Author:

Matti Rinta-Nikkola

Method Summary

Modifier and Type	Method and Description
void	del(String... vars) Deletes variables.
default Object	execute(File script) Executes scriptEngine script
Object	execute(File script, Object[] args) Executes scriptEngine script
Object	execute(String statement) Executes scriptEngine statement
default Object	expandParameter(String variable) Substitute variable reference with its value.
Object	expandParameter(String variable, String format) Substitute variable reference with its value.
default Map<String,Object>	find() Gets all variables with values
Map<String,Object>	find(String name) Gets all the variables that match the name.
Object	get(String name) Gets variable value
String	getEngineName()
Collection<String>	getExtensions()
boolean	hasVariable(String name) Tests if console variable exists
default void	persist(Path file, Object object) Persists object value to file.
void	persist(Path file, Object object, String format) Persists object value to file.
void	put(String name, Object value) Creates variable
String	toJson(Object object) Converts object to JSON string.
String	toString(Object object) Converts object to string.

Method Detail

getEngineName

String getEngineName()

Returns:

scriptEngine name

getExtensions

Collection<String> getExtensions()

Returns:

script file name extensions

hasVariable

boolean hasVariable(String name)

Tests if console variable exists

Parameters:

name -

Returns:

true if variable exists

put

void put(String name,
         Object value)

Creates variable

Parameters:

name - of the variable

value - of the variable

get

Object get(String name)

Gets variable value

Parameters:

name - of the variable

Returns:

value of the variable

find

default Map<String,Object> find()

Gets all variables with values

Returns:

map of the variables

find

Map<String,Object> find(String name)

Gets all the variables that match the name. Name can contain * wild cards.

Parameters:

name - of the variable

Returns:

map of the variables

del

void del(String... vars)

Deletes variables. Variable name cab contain * wild cards.

Parameters:

vars -

toJson

String toJson(Object object)

Converts object to JSON string.

Parameters:

object - object to convert to JSON

Returns:

formatted JSON string

toString

String toString(Object object)

Converts object to string.

Parameters:

object - object to convert to string

Returns:

object string value

expandParameter

default Object expandParameter(String variable)

Substitute variable reference with its value.

Parameters:

variable -

Returns:

Substituted variable

Throws:

Exception

expandParameter

Object expandParameter(String variable,
                       String format)

Substitute variable reference with its value.

Parameters:

variable -

format - serialization format

Returns:

Substituted variable

Throws:

Exception

persist

default void persist(Path file,
                     Object object)

Persists object value to file.

Parameters:

file -

object -

persist

void persist(Path file,
             Object object,
             String format)

Persists object value to file.

Parameters:

file -

object -

format -

execute

Object execute(String statement)
        throws Exception

Executes scriptEngine statement

Parameters:

statement -

Returns:

result

Throws:

Exception

execute

default Object execute(File script)
                throws Exception

Executes scriptEngine script

Parameters:

script -

Returns:

result

Throws:

Exception

execute

Object execute(File script,
               Object[] args)
        throws Exception

Executes scriptEngine script

Parameters:

script -

args -

Returns:

Throws:

Exception