org.gbif.api.model.crawler

Enum FinishReason

java.lang.Object

java.lang.Enum<FinishReason>

org.gbif.api.model.crawler.FinishReason

All Implemented Interfaces:

Serializable, Comparable<FinishReason>

public enum FinishReason
extends Enum<FinishReason>

This enum lists the reasons why a crawl is finished.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABORT This status means that we had to abort the crawl for any abnormal reason (endpoint down, not a valid archive, ...).
NORMAL This status means that we were able to finish the crawl without any fatal errors and without exhausting retries.
NOT_MODIFIED Crawling has stopped because the source data was not modified since the last crawl.
UNKNOWN This status means that we don't know why the crawl aborted.
USER_ABORT This status means that the user requested an abort of the crawl and that is the reason this crawl is done.

Method Summary

Modifier and Type	Method and Description
static FinishReason	valueOf(String name) Returns the enum constant of this type with the specified name.
static FinishReason[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NORMAL

public static final FinishReason NORMAL

This status means that we were able to finish the crawl without any fatal errors and without exhausting retries. There could still have been intermittent errors but we managed to reach the end of an endpoint or a DwC-A file.

USER_ABORT

public static final FinishReason USER_ABORT

This status means that the user requested an abort of the crawl and that is the reason this crawl is done.

ABORT

public static final FinishReason ABORT

This status means that we had to abort the crawl for any abnormal reason (endpoint down, not a valid archive, ...). To find the exact reason(s) you need to look at the logs to see past errors.

NOT_MODIFIED

public static final FinishReason NOT_MODIFIED

Crawling has stopped because the source data was not modified since the last crawl.

UNKNOWN

public static final FinishReason UNKNOWN

This status means that we don't know why the crawl aborted. This is a sign of a programming error and should be investigated.

Method Detail

values

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

Returns:

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

valueOf

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