com.screenscraper.events.script

Enum ScriptEventFireTime

java.lang.Object

java.lang.Enum<ScriptEventFireTime>

com.screenscraper.events.script.ScriptEventFireTime

All Implemented Interfaces:

EventFireTime<ScriptEventData>, java.io.Serializable, java.lang.Comparable<ScriptEventFireTime>

public enum ScriptEventFireTime
extends java.lang.Enum<ScriptEventFireTime>
implements EventFireTime<ScriptEventData>

Event firing times for script events

Version:

6.0.55a

Enum Constant Summary

Enum Constants

Enum Constant and Description
AfterScript After a script is executed
BeforeScript Before a script is executed
OnScriptEnd Run when the script finishes executing.
OnScriptError Executes when an error occurs in a script
OnScriptStart Run when the script begins to execute.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getDefaultReturnValue(ScriptEventData data) Gets the default value to return for this time from the data
static ScriptEventFireTime	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ScriptEventFireTime[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BeforeScript

public static final ScriptEventFireTime BeforeScript

Before a script is executed

OnScriptStart

public static final ScriptEventFireTime OnScriptStart

Run when the script begins to execute. The difference between BeforeScript and this is that BeforeScript fires as preparation is made to launch a script, and this runs after all the default pre-script code is executed by the script engine, but before the developer code in the script. The return value is an injected string to execute, or null (or the empty string) to do nothing aside from execute the script code

OnScriptEnd

public static final ScriptEventFireTime OnScriptEnd

Run when the script finishes executing. The difference between AfterScript and this is that AfterScript fires after the script is done running, and this runs after all the developer code has run but the script engine is still active. The return value is an injected string to execute, or null (or the empty string) to do nothing aside from execute the script code

OnScriptError

public static final ScriptEventFireTime OnScriptError

Executes when an error occurs in a script

AfterScript

public static final ScriptEventFireTime AfterScript

After a script is executed

Method Detail

values

public static ScriptEventFireTime[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ScriptEventFireTime c : ScriptEventFireTime.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ScriptEventFireTime valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getDefaultReturnValue

@Nullable
public java.lang.Object getDefaultReturnValue(ScriptEventData data)

Gets the default value to return for this time from the data

Specified by:

getDefaultReturnValue in interface EventFireTime<ScriptEventData>

Parameters:

data - The default value to return

Returns:

The value to return by default