org.elasticsearch.hadoop.handler

Enum HandlerResult

java.lang.Object

java.lang.Enum<HandlerResult>

org.elasticsearch.hadoop.handler.HandlerResult

All Implemented Interfaces:

Serializable, Comparable<HandlerResult>

public enum HandlerResult
extends Enum<HandlerResult>

Values that denote the result of an action taken by an ErrorHandler.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABORT Signals to the connector that the given ErrorHandler determined that the given failure scenario is grounds to abort the job.
HANDLED Signals to the connector that the given ErrorHandler was successfully able to handle the failure scenario, either by swallowing the failure, persisting the operation for examination, or attempting to retry the operation.
PASS Signals to the connector that the given ErrorHandler was unable to handle the failure scenario.

Method Summary

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

HANDLED

public static final HandlerResult HANDLED

Signals to the connector that the given ErrorHandler was successfully able to handle the failure scenario, either by swallowing the failure, persisting the operation for examination, or attempting to retry the operation. In this case, the handling for this failure instance is stopped and no further handlers in the chain will be called.

PASS

public static final HandlerResult PASS

Signals to the connector that the given ErrorHandler was unable to handle the failure scenario. In this case, the failure information is passed on to the next configured handler in the chain.

ABORT

public static final HandlerResult ABORT

Signals to the connector that the given ErrorHandler determined that the given failure scenario is grounds to abort the job. In this case, the original error information will be extracted and thrown with no further handlers in the chain being called.

Method Detail

values

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

Returns:

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

valueOf

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