com.marklogic.client.datamovement

Enum RowBatchFailureListener.BatchFailureDisposition

java.lang.Object

java.lang.Enum<RowBatchFailureListener.BatchFailureDisposition>

com.marklogic.client.datamovement.RowBatchFailureListener.BatchFailureDisposition

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<RowBatchFailureListener.BatchFailureDisposition>

Enclosing interface:

RowBatchFailureListener

public static enum RowBatchFailureListener.BatchFailureDisposition
extends java.lang.Enum<RowBatchFailureListener.BatchFailureDisposition>

Specifies how the RowBatcher should respond to the failure to retrieve a batch of rows.

Enum Constant Summary

Enum Constants

Enum Constant and Description
RETRY Attempt to retrieve the batch rows again.
SKIP Ignore the exception and try to get another batch of rows without retrieving the current batch of rows.
STOP Stop the job, retrieving no more rows.

Method Summary

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

RETRY

public static final RowBatchFailureListener.BatchFailureDisposition RETRY

Attempt to retrieve the batch rows again. This disposition is appropriate only if the exception indicates that the request might succeed if repeated.

SKIP

public static final RowBatchFailureListener.BatchFailureDisposition SKIP

Ignore the exception and try to get another batch of rows without retrieving the current batch of rows. This disposition is appropriate only if the exception indicates an issue specific to the batch of rows.

STOP

public static final RowBatchFailureListener.BatchFailureDisposition STOP

Stop the job, retrieving no more rows. This disposition is appropriate if the exception indicates that attempts to retrieve batches of rows for a view are likely to fail.

Method Detail

values

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

Returns:

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

valueOf

public static RowBatchFailureListener.BatchFailureDisposition 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