com.screenscraper.events.session

Enum SessionEventFireTime

java.lang.Object

java.lang.Enum<SessionEventFireTime>

com.screenscraper.events.session.SessionEventFireTime

All Implemented Interfaces:

EventFireTime<SessionEventData>, java.io.Serializable, java.lang.Comparable<SessionEventFireTime>

public enum SessionEventFireTime
extends java.lang.Enum<SessionEventFireTime>
implements EventFireTime<SessionEventData>

Event firing times for session events

Version:

6.0.55a

Enum Constant Summary

Enum Constants

Enum Constant and Description
AfterEndAndOtherCallbacks After the scrape finishes and all scripts have been run.
AfterEndScripts After the scrape finishes and all scripts have been run
NumDuplicateRecordsSavedModified When the ScrapingSession.addToNumDuplicateRecordsScraped(int) is called, this will also be called.
NumErrorRecordsSavedModified When the ScrapingSession.addToNumErrorRecordsScraped(int) is called, this will also be called.
NumNewRecordsSavedModified When the ScrapingSession.addToNumNewRecordsScraped(int) is called, this will also be called.
NumRecordsSavedModified When the ScrapingSession.addToNumRecordsScraped(Object) is called, this will also be called.
NumUpdatedRecordsSavedModified When the ScrapingSession.addToNumUpdatedRecordsScraped(int) is called, this will also be called.
SessionVariableRetrieved Called whenever a session variable is retrieved.
SessionVariableSet Called whenever a session variable is set.
StopScrapingCalled When the session is stopped, either by calling the stopScraping method or clicking the stop scraping button in the workbench

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getDefaultReturnValue(SessionEventData data) Gets the default value to return for this time from the data
static SessionEventFireTime	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SessionEventFireTime[]	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

NumRecordsSavedModified

public static final SessionEventFireTime NumRecordsSavedModified

When the ScrapingSession.addToNumRecordsScraped(Object) is called, this will also be called. The returned value will be the actual value to add.

NumNewRecordsSavedModified

public static final SessionEventFireTime NumNewRecordsSavedModified

When the ScrapingSession.addToNumNewRecordsScraped(int) is called, this will also be called. The returned value will be the actual value to add.

Since:

7.0.1a

NumDuplicateRecordsSavedModified

public static final SessionEventFireTime NumDuplicateRecordsSavedModified

When the ScrapingSession.addToNumDuplicateRecordsScraped(int) is called, this will also be called. The returned value will be the actual value to add.

Since:

7.0.1a

NumUpdatedRecordsSavedModified

public static final SessionEventFireTime NumUpdatedRecordsSavedModified

When the ScrapingSession.addToNumUpdatedRecordsScraped(int) is called, this will also be called. The returned value will be the actual value to add.

Since:

7.0.1a

NumErrorRecordsSavedModified

public static final SessionEventFireTime NumErrorRecordsSavedModified

When the ScrapingSession.addToNumErrorRecordsScraped(int) is called, this will also be called. The returned value will be the actual value to add.

Since:

7.0.1a

StopScrapingCalled

public static final SessionEventFireTime StopScrapingCalled

When the session is stopped, either by calling the stopScraping method or clicking the stop scraping button in the workbench

AfterEndScripts

public static final SessionEventFireTime AfterEndScripts

After the scrape finishes and all scripts have been run

AfterEndAndOtherCallbacks

@InternalOnly
public static final SessionEventFireTime AfterEndAndOtherCallbacks

After the scrape finishes and all scripts have been run. This is also after all AfterEndScripts fire time. This is used internally and should be avoided by outside code (in theory it can be used externally, but then parent/child scrapes might be notified that a scrape has finished when it really hasn't. Only the final "Session completed" log message has to be written

SessionVariableSet

public static final SessionEventFireTime SessionVariableSet

Called whenever a session variable is set. This is called before the value is actually set. The variable value passed in will be the new value to be set, and the return value of the handler will be the actual value returned. Note that calling a setVariable or getVariable in here WILL trigger the events for those again. Avoid infinite recursion!

SessionVariableRetrieved

public static final SessionEventFireTime SessionVariableRetrieved

Called whenever a session variable is retrieved. This is called after the value is retrieved. The variable value passed in will be the current value, and the return value of the handler will be the actual value returned. Note that calling a setVariable or getVariable in here WILL trigger the events for those again. Avoid infinite recursion!

Method Detail

values

public static SessionEventFireTime[] 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 (SessionEventFireTime c : SessionEventFireTime.values())
    System.out.println(c);

Returns:

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

valueOf

public static SessionEventFireTime 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(SessionEventData data)

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

Specified by:

getDefaultReturnValue in interface EventFireTime<SessionEventData>

Parameters:

data - The default value to return

Returns:

The value to return by default