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

Class InlineScriptSpec

java.lang.Object

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

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

public final class InlineScriptSpec
extends AbstractScriptSpec

Field Summary

Fields inherited from class com.hpe.caf.worker.document.scripting.specs.AbstractScriptSpec

engineType

Constructor Summary

Constructors

Constructor and Description
InlineScriptSpec(String script, ScriptEngineType engineType)

Method Summary

Modifier and Type	Method and Description
CompiledScript	compile(Compilable compiler) Compiles the script for later execution.
boolean	equals(Object obj)
String	getScript() Returns the script represented by this specification.
int	hashCode()
boolean	isStatic() Returns whether the script specification represents a script that is static (i.e.
protected void	setScriptSpecField(DocumentWorkerScript script) Updates the relevant field in the specified script.

Methods inherited from class com.hpe.caf.worker.document.scripting.specs.AbstractScriptSpec

create, getEngineType, toDocumentWorkerScript

Methods inherited from class java.lang.Object

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

Constructor Detail

InlineScriptSpec

public InlineScriptSpec(String script,
                        ScriptEngineType engineType)

Method Detail

compile

@Nonnull
public CompiledScript compile(Compilable compiler)
                                throws ScriptException

Description copied from class: AbstractScriptSpec

Compiles the script for later execution.

Specified by:

compile in class AbstractScriptSpec

Parameters:

compiler - the engine to use to do the compilation

Returns:

the object code for the script

Throws:

ScriptException - if compilation fails

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getScript

@Nonnull
public String getScript()

Description copied from class: AbstractScriptSpec

Returns the script represented by this specification.

Specified by:

getScript in class AbstractScriptSpec

Returns:

the script represented by this specification

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isStatic

public boolean isStatic()

Description copied from class: AbstractScriptSpec

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).

Specified by:

isStatic in class AbstractScriptSpec

Returns:

true if the script specified is constant

setScriptSpecField

protected void setScriptSpecField(DocumentWorkerScript script)

Description copied from class: AbstractScriptSpec

Updates the relevant field in the specified script.

Specified by:

setScriptSpecField in class AbstractScriptSpec

Parameters:

script - the script object to be updated