com.screenscraper.events.scrapeablefile

Enum ScrapeableFileEventFireTime

java.lang.Object

java.lang.Enum<ScrapeableFileEventFireTime>

com.screenscraper.events.scrapeablefile.ScrapeableFileEventFireTime

All Implemented Interfaces:

EventFireTime<ScrapeableFileEventData>, java.io.Serializable, java.lang.Comparable<ScrapeableFileEventFireTime>

public enum ScrapeableFileEventFireTime
extends java.lang.Enum<ScrapeableFileEventFireTime>
implements EventFireTime<ScrapeableFileEventData>

Firing times for Scrapeable File events

Version:

6.0.55a

Enum Constant Summary

Enum Constants

Enum Constant and Description
AfterHttpRequest Fired right after getting the http response and running tidy, if set, but before anything else happens.
AfterScrapeableFile After a scrapeable file is completed (including after any scripts on it run)
BeforeHttpRequest Fired right before issuing the http request (after any "before scrapeable file" scripts, and will fire each time the request is retried).
BeforeScrapeableFile Before a scrapeable file is launched (including before any scripts on it run)
BeforeScrapeFromString Fired just before setting the content on a scrapeString request.
OnHttpRedirect Called when a redirect will occur, and returns true if a redirect should occur or false if it should not (any non boolean results in no change)

Method Summary

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

BeforeScrapeableFile

public static final ScrapeableFileEventFireTime BeforeScrapeableFile

Before a scrapeable file is launched (including before any scripts on it run)

BeforeHttpRequest

public static final ScrapeableFileEventFireTime BeforeHttpRequest

Fired right before issuing the http request (after any "before scrapeable file" scripts, and will fire each time the request is retried). If it returns a non-null String, that will be used as the response instead of issuing a request. This response will still get passed into the AfterHttpRequest event, but it will not pass through any tidying

BeforeScrapeFromString

public static final ScrapeableFileEventFireTime BeforeScrapeFromString

Fired just before setting the content on a scrapeString request. If this is called, there will be no calls for the HttpRequest events on the scrapeable file. Likewise, if one of the HttpRequests is called, this event time will not be called. The return value is the String that will be used as the scrapeable file content. The String scrapeable file content will be set in the HttpResponseData value on the event. This event fires after any BeforeScrapeableFile events and scripts, but before any extractors are run

AfterHttpRequest

public static final ScrapeableFileEventFireTime AfterHttpRequest

Fired right after getting the http response and running tidy, if set, but before anything else happens. Returns the data that should be used as the response data

AfterScrapeableFile

public static final ScrapeableFileEventFireTime AfterScrapeableFile

After a scrapeable file is completed (including after any scripts on it run)

OnHttpRedirect

public static final ScrapeableFileEventFireTime OnHttpRedirect

Called when a redirect will occur, and returns true if a redirect should occur or false if it should not (any non boolean results in no change)

Method Detail

values

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

Returns:

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

valueOf

public static ScrapeableFileEventFireTime 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(ScrapeableFileEventData data)

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

Specified by:

getDefaultReturnValue in interface EventFireTime<ScrapeableFileEventData>

Parameters:

data - The default value to return

Returns:

The value to return by default