org.macroing.cel4j.artifact

Class ArtifactScript

java.lang.Object

javax.script.CompiledScript

org.macroing.cel4j.artifact.ArtifactScript

public abstract class ArtifactScript
extends javax.script.CompiledScript

ArtifactScript is an implementation of CompiledScript and is extended by each script class that is evaluated by this Artifact ScriptEngine implementation.

The purpose with this class, is to supply all script writers with a simple API they can use when writing their scripts.

Since:

1.0.0

Author:

Jörgen Lundgren

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ArtifactScript(javax.script.ScriptEngine scriptEngine) Constructs a new ArtifactScript instance.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	eval(java.lang.String script) Executes script as script.
java.lang.Object	get(java.lang.String key) Returns the value assigned to key, or null if no value is assigned to key.
javax.script.ScriptEngine	getEngine() Returns the ScriptEngine whose compile method created this ArtifactScript.
void	set(java.lang.String key, java.lang.Object value) Sets the value value for the key key.

Methods inherited from class javax.script.CompiledScript

eval, eval, eval

Methods inherited from class java.lang.Object

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

Constructor Detail

ArtifactScript

protected ArtifactScript(javax.script.ScriptEngine scriptEngine)

Constructs a new ArtifactScript instance.

If scriptEngine is null, a NullPointerException will be thrown.

Parameters:

scriptEngine - a ScriptEngine

Throws:

java.lang.NullPointerException - thrown if, and only if, scriptEngine is null

Method Detail

eval

public final java.lang.Object eval(java.lang.String script)
                            throws javax.script.ScriptException

Executes script as script.

Returns the return value of the script.

If script is null, a NullPointerException will be thrown.

If an error occurs in the script, a ScriptException will be thrown.

Parameters:

script - the script to execute

Returns:

the return value of the script

Throws:

java.lang.NullPointerException - thrown if, and only if, script is null

javax.script.ScriptException - thrown if, and only if, an error occurs in the script

get

public final java.lang.Object get(java.lang.String key)

Returns the value assigned to key, or null if no value is assigned to key.

If key is null, a NullPointerException will be thrown.

If key is an empty String, an IllegalArgumentException will be thrown.

Parameters:

key - a String

Returns:

the value assigned to key, or null if no value is assigned to key

Throws:

java.lang.IllegalArgumentException - thrown if, and only if, key is an empty String

java.lang.NullPointerException - thrown if, and only if, key is null

getEngine

public final javax.script.ScriptEngine getEngine()

Returns the ScriptEngine whose compile method created this ArtifactScript.

Specified by:

getEngine in class javax.script.CompiledScript

Returns:

the ScriptEngine whose compile method created this ArtifactScript

set

public final void set(java.lang.String key,
                      java.lang.Object value)

Sets the value value for the key key.

If key is null, a NullPointerException will be thrown.

If key is an empty String, an IllegalArgumentException will be thrown.

Parameters:

key - the key

value - the value

Throws:

java.lang.IllegalArgumentException - thrown if, and only if, key is an empty String

java.lang.NullPointerException - thrown if, and only if, key is null