org.scripthelper.context

Interface ScriptContext

All Known Implementing Classes:

DefaultScriptContext

public interface ScriptContext

The script context.

Method Summary

Modifier and Type	Method and Description
default void	__step__(java.lang.Object... args) Enter a step.
void	abort(java.lang.String message) Abort the current script.
default void	clearTab() Clear the current value of the tab for the text.
default void	echo(java.lang.Number number) Echo a number.
default void	echo(java.lang.Number number, java.lang.String htmlColor) Echo a number with a specified color.
void	echo(java.lang.String message) Echo a message.
default void	echo(java.lang.String message, java.lang.String htmlColor) Echo a message with a specified color.
void	error(java.lang.String message) Error a message.
default java.lang.Object	getAdditionalHelper(java.lang.String name) Return the additional helper with a specified name.
default java.util.Map<java.lang.String,java.lang.Object>	getAdditionalHelpers() Return the additional helpers.
default ScriptHelper	getHelper() Return the script helper.
java.io.File	getPath(java.lang.String path) Return the absolute path of a file defined relative to the script file.
default java.io.File	getScriptFile() Return the script file.
ScriptLogger	getScriptLogger() Return the associated ScriptLogger.
ScriptSource	getScriptSource() Return the script source.
default ScriptWrapper<?>	getScriptWrapper() Return the script wrapper.
default boolean	hasAdditionalHelpers() Return true if there are additional helpers.
void	setLogger(ScriptLogger logger) Set the associated ScriptLogger.
default void	setProgress(float value) Set the value of the script progression.
void	setScriptSource(ScriptSource source) Set the Script source.
default void	setScriptWrapper(ScriptWrapper<?> wrapper) Set the script wrapper.
default void	setTab(int tabs) Set the current value for of the tab for the text.

Method Detail

setScriptWrapper

default void setScriptWrapper(ScriptWrapper<?> wrapper)

Set the script wrapper. Do nothing by default.

Parameters:

wrapper - the script wrapper

getScriptWrapper

default ScriptWrapper<?> getScriptWrapper()

Return the script wrapper. Return null by default.

Returns:

the script wrapper

getHelper

default ScriptHelper getHelper()

Return the script helper. Return null by default.

Returns:

the script helper

setScriptSource

void setScriptSource(ScriptSource source)

Set the Script source.

Parameters:

source - the script source

setLogger

void setLogger(ScriptLogger logger)

Set the associated ScriptLogger.

Parameters:

logger - the associated ScriptLogger

getScriptLogger

ScriptLogger getScriptLogger()

Return the associated ScriptLogger.

Returns:

the associated ScriptLogger

getAdditionalHelpers

default java.util.Map<java.lang.String,java.lang.Object> getAdditionalHelpers()

Return the additional helpers.

Returns:

the additional helpers

getAdditionalHelper

default java.lang.Object getAdditionalHelper(java.lang.String name)

Return the additional helper with a specified name.

Parameters:

name - the helper name

Returns:

the additional helper

hasAdditionalHelpers

default boolean hasAdditionalHelpers()

Return true if there are additional helpers.

Returns:

true if there are additional helpers

getScriptSource

ScriptSource getScriptSource()

Return the script source.

Returns:

the script source

getScriptFile

default java.io.File getScriptFile()

Return the script file.

Returns:

the script file

echo

void echo(java.lang.String message)

Echo a message.

Parameters:

message - the message text

echo

default void echo(java.lang.String message,
                  java.lang.String htmlColor)

Echo a message with a specified color. By default defer to echo(java.lang.String).

Parameters:

message - the message text

htmlColor - the message color

echo

default void echo(java.lang.Number number)

Echo a number.

Parameters:

number - the number

echo

default void echo(java.lang.Number number,
                  java.lang.String htmlColor)

Echo a number with a specified color.

Parameters:

number - the number

htmlColor - the number color

error

void error(java.lang.String message)

Error a message.

Parameters:

message - the message text

clearTab

default void clearTab()

Clear the current value of the tab for the text. All subsequent lines will be presented without tab. Do nothing by default.

setTab

default void setTab(int tabs)

Set the current value for of the tab for the text. All subsequent lines will be presented with a tab of tabs. Do nothing by default.

Parameters:

tabs - the current value for of the tab for the text

setProgress

default void setProgress(float value)

Set the value of the script progression.

Parameters:

value - the value

getPath

java.io.File getPath(java.lang.String path)

Return the absolute path of a file defined relative to the script file.

Parameters:

path - the relative path

Returns:

the absolute path

abort

void abort(java.lang.String message)
    throws AbortScriptException

Abort the current script. The Scripting engine will use the throwable exception to stop the execution.

Parameters:

message - the abort message

Throws:

AbortScriptException - the exception used to abort the Script

__step__

default void __step__(java.lang.Object... args)

Enter a step. Do nothing by default.

Parameters:

args - the arguments