com.screenscraper.scraper

Enum StopScrapingCallType

java.lang.Object

java.lang.Enum<StopScrapingCallType>

com.screenscraper.scraper.StopScrapingCallType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<StopScrapingCallType>

public enum StopScrapingCallType
extends java.lang.Enum<StopScrapingCallType>

Represents common times/reasons when/why a scrape was stopped

Enum Constant Summary

Enum Constants

Enum Constant and Description
Custom Some custom reason
ExternalFromSession The stop was because something external to the scrape told it to stop.
ExternalService Some External service told this to stop.
ManualStop The stop was called by clicking the stop button, either in the workbench or the web interface
ProxyError The stop was caused by an error setting up or using proxies
RetriesFailed The stop was called by failing to fix the issue after retrying enough times.
Scripted The stop was called by code in the scrape
ScriptExecutionError An error was thrown while executing a script, which caused the scrape to stop
ThreadInterrupted The stop was because the thread the scrape was running in was interrupted
Timeout The stop was because it had been running too long or something timed out, such as an extractor, and the scrape had been told to stop in those cases
Unspecified Unsure where the stop call came from

Method Summary

Modifier and Type	Method and Description
static StopScrapingCallType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static StopScrapingCallType[]	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

ManualStop

public static final StopScrapingCallType ManualStop

The stop was called by clicking the stop button, either in the workbench or the web interface

Timeout

public static final StopScrapingCallType Timeout

The stop was because it had been running too long or something timed out, such as an extractor, and the scrape had been told to stop in those cases

ThreadInterrupted

public static final StopScrapingCallType ThreadInterrupted

The stop was because the thread the scrape was running in was interrupted

ExternalFromSession

public static final StopScrapingCallType ExternalFromSession

The stop was because something external to the scrape told it to stop. This includes stopping from a RunnableScrapingSession's stopScraping method, or calling internal methods to stop all scrapes, etc... It is not simply because the stop scraping method was called from clicking a stop button

RetriesFailed

public static final StopScrapingCallType RetriesFailed

The stop was called by failing to fix the issue after retrying enough times. When using a custom retry policy (not from the factory) if the scrape is stopped this won't be set by default as the reason.

ProxyError

public static final StopScrapingCallType ProxyError

The stop was caused by an error setting up or using proxies

ScriptExecutionError

public static final StopScrapingCallType ScriptExecutionError

An error was thrown while executing a script, which caused the scrape to stop

Unspecified

public static final StopScrapingCallType Unspecified

Unsure where the stop call came from

Scripted

public static final StopScrapingCallType Scripted

The stop was called by code in the scrape

ExternalService

public static final StopScrapingCallType ExternalService

Some External service told this to stop. For example, if an external program is launching scrapes and tells one to stop, this would be the preferred stop type (unless another type makes more sense)

Custom

public static final StopScrapingCallType Custom

Some custom reason

Method Detail

values

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

Returns:

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

valueOf

public static StopScrapingCallType 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