com.marklogic.client.datamovement

Enum ApplyTransformListener.ApplyResult

java.lang.Object

java.lang.Enum<ApplyTransformListener.ApplyResult>

com.marklogic.client.datamovement.ApplyTransformListener.ApplyResult

All Implemented Interfaces:

Serializable, Comparable<ApplyTransformListener.ApplyResult>

Enclosing class:

ApplyTransformListener

public static enum ApplyTransformListener.ApplyResult
extends Enum<ApplyTransformListener.ApplyResult>

Either REPLACE each document with the result of the transform, or run the transform with each document as input, but IGNORE the result.

Enum Constant Summary

Enum Constants

Enum Constant and Description
IGNORE Run the transform on each document, but ignore the value returned by the transform because the transform will do any necessary database modifications or other processing.
REPLACE (Default) Overwrites documents with the value returned by the transform, just like REST write transforms.

Method Summary

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

REPLACE

public static final ApplyTransformListener.ApplyResult REPLACE

(Default) Overwrites documents with the value returned by the transform, just like REST write transforms. This is the default behavior.

IGNORE

public static final ApplyTransformListener.ApplyResult IGNORE

Run the transform on each document, but ignore the value returned by the transform because the transform will do any necessary database modifications or other processing. For example, a transform might call out to an external REST service or perhaps write multiple additional documents.

Method Detail

values

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

Returns:

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

valueOf

public static ApplyTransformListener.ApplyResult 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