org.scripthelper.context

Class DefaultScriptContext

java.lang.Object

org.scripthelper.context.DefaultScriptContext

All Implemented Interfaces:

ScriptContext

public class DefaultScriptContext
extends java.lang.Object
implements ScriptContext

A default script context.

Constructor Summary

Constructors

Constructor and Description
DefaultScriptContext() Constructor.

Method Summary

Modifier and Type	Method and Description
void	__step__(java.lang.Object... args) Enter a step.
void	abort(java.lang.String message) Abort the current script.
void	echo(java.lang.String message) Echo a message.
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.
java.io.File	getPath(java.lang.String path) Return the absolute path of a file defined relative to the script file.
ScriptLogger	getScriptLogger() Return the associated ScriptLogger.
ScriptSource	getScriptSource() Return the script source.
ScriptWrapper<?>	getScriptWrapper() Return the script wrapper.
void	setLogger(ScriptLogger logger) Set the associated ScriptLogger.
void	setScriptSource(ScriptSource source) Set the Script source.
void	setScriptWrapper(ScriptWrapper<?> wrapper) Set the script wrapper.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.scripthelper.context.ScriptContext

clearTab, echo, echo, getAdditionalHelper, getAdditionalHelpers, getHelper, getScriptFile, hasAdditionalHelpers, setProgress, setTab

Constructor Detail

DefaultScriptContext

public DefaultScriptContext()

Constructor.

Method Detail

setScriptWrapper

public void setScriptWrapper(ScriptWrapper<?> wrapper)

Set the script wrapper.

Specified by:

setScriptWrapper in interface ScriptContext

Parameters:

wrapper - the script wrapper

getScriptWrapper

public ScriptWrapper<?> getScriptWrapper()

Return the script wrapper. Return null by default.

Specified by:

getScriptWrapper in interface ScriptContext

Returns:

the script wrapper

setScriptSource

public void setScriptSource(ScriptSource source)

Set the Script source.

Specified by:

setScriptSource in interface ScriptContext

Parameters:

source - the script source

setLogger

public void setLogger(ScriptLogger logger)

Set the associated ScriptLogger.

Specified by:

setLogger in interface ScriptContext

Parameters:

logger - the associated ScriptLogger

getScriptLogger

public ScriptLogger getScriptLogger()

Return the associated ScriptLogger.

Specified by:

getScriptLogger in interface ScriptContext

Returns:

the associated ScriptLogger

getScriptSource

public ScriptSource getScriptSource()

Return the script source.

Specified by:

getScriptSource in interface ScriptContext

Returns:

the script source

echo

public void echo(java.lang.String message)

Echo a message.

Specified by:

echo in interface ScriptContext

Parameters:

message - the message text

echo

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

Echo a message with a specified color.

Specified by:

echo in interface ScriptContext

Parameters:

message - the message text

htmlColor - the message color

error

public void error(java.lang.String message)

Error a message.

Specified by:

error in interface ScriptContext

Parameters:

message - the message text

getPath

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

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

Specified by:

getPath in interface ScriptContext

Parameters:

path - the relative path

Returns:

the absolute path

abort

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

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

Specified by:

abort in interface ScriptContext

Parameters:

message - the abort message

Throws:

AbortScriptException - the exception used to abort the Script

__step__

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

Enter a step.

Specified by:

__step__ in interface ScriptContext

Parameters:

args - the arguments