com.hpe.caf.worker.document.scripting.specs

Class AbstractScriptSpec

java.lang.Object

com.hpe.caf.worker.document.scripting.specs.AbstractScriptSpec

Direct Known Subclasses:

InlineScriptSpec, RemoteScriptSpec

public abstract class AbstractScriptSpec
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected ScriptEngineType	engineType

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractScriptSpec(ScriptEngineType engineType)

Method Summary

Modifier and Type	Method and Description
abstract CompiledScript	compile(Compilable compiler) Compiles the script for later execution.
static AbstractScriptSpec	create(ApplicationImpl application, DocumentWorkerScript script) Constructs the appropriate implementation for the specified script data.
ScriptEngineType	getEngineType() Returns the JavaScript engine to use for the script represented by this specification.
abstract String	getScript() Returns the script represented by this specification.
abstract boolean	isStatic() Returns whether the script specification represents a script that is static (i.e.
protected abstract void	setScriptSpecField(DocumentWorkerScript script) Updates the relevant field in the specified script.
DocumentWorkerScript	toDocumentWorkerScript(String name) Creates a new DocumentWorkerScript for the script specification.

Methods inherited from class java.lang.Object

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

Field Detail

engineType

protected final ScriptEngineType engineType

Constructor Detail

AbstractScriptSpec

protected AbstractScriptSpec(ScriptEngineType engineType)

Method Detail

create

public static AbstractScriptSpec create(ApplicationImpl application,
                                        DocumentWorkerScript script)
                                 throws InvalidScriptException

Constructs the appropriate implementation for the specified script data.

Parameters:

application - the global data for the worker

script - the object that contains the script data

Returns:

an object that can be used to retrieve or compile the script, or null if the script data object is not initialized

Throws:

InvalidScriptException - if the specified script data is invalid is some way

compile

@Nonnull
public abstract CompiledScript compile(Compilable compiler)
                                         throws ScriptException

Compiles the script for later execution.

Parameters:

compiler - the engine to use to do the compilation

Returns:

the object code for the script

Throws:

ScriptException - if compilation fails

getEngineType

@Nonnull
public final ScriptEngineType getEngineType()

Returns the JavaScript engine to use for the script represented by this specification.

Returns:

the JavaScript engine to use for the script represented by this specification.

getScript

@Nonnull
public abstract String getScript()
                                   throws IOException

Returns the script represented by this specification.

Returns:

the script represented by this specification

Throws:

IOException - if the script could not be retrieved

isStatic

public abstract boolean isStatic()

Returns whether the script specification represents a script that is static (i.e. it is always the same each time it is retrieved), as opposed to one which is dynamic (i.e. it references a script which might change).

Returns:

true if the script specified is constant

toDocumentWorkerScript

@Nonnull
public final DocumentWorkerScript toDocumentWorkerScript(String name)

Creates a new DocumentWorkerScript for the script specification.

Parameters:

name - the name of the script to use

Returns:

the new DocumentWorkerScript object

setScriptSpecField

protected abstract void setScriptSpecField(DocumentWorkerScript script)

Updates the relevant field in the specified script.

Parameters:

script - the script object to be updated