Package org.webharvest.runtime

Enum ScraperState

java.lang.Object

java.lang.Enum<ScraperState>

org.webharvest.runtime.ScraperState

All Implemented Interfaces:

Serializable, Comparable<ScraperState>

public enum ScraperState
extends Enum<ScraperState>

An enum containing all available Scraper's states.

Since:

2.1-SNAPSHOT

Version:

%I%, %G%

Author:

mczapiewski

Enum Constant Summary

Enum Constants

Enum Constant	Description
ERROR	Scraper has finished its work with error.
EXIT	Scraper's execution has been stopped by exit command.
FINISHED	Scraper has successfully finished its work.
PAUSED	Scraper has been paused.
READY	Scraper is ready to use.
RUNNING	Scraper is running.
STOPPED	Scraper has been stopped by the user.
UNKNOWN	Deprecated.

Method Summary

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

READY

public static final ScraperState READY

Scraper is ready to use.

RUNNING

public static final ScraperState RUNNING

Scraper is running.

PAUSED

public static final ScraperState PAUSED

Scraper has been paused.

FINISHED

public static final ScraperState FINISHED

Scraper has successfully finished its work.

STOPPED

public static final ScraperState STOPPED

Scraper has been stopped by the user.

ERROR

public static final ScraperState ERROR

Scraper has finished its work with error.

EXIT

public static final ScraperState EXIT

Scraper's execution has been stopped by exit command.

UNKNOWN

@Deprecated
public static final ScraperState UNKNOWN

Deprecated.

Unknown state of the Scraper.

Method Detail

values

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

Returns:

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

valueOf

public static ScraperState valueOf(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:

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

NullPointerException - if the argument is null