org.apache.samza.drain

Enum DrainMode

java.lang.Object

java.lang.Enum<DrainMode>

org.apache.samza.drain.DrainMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DrainMode>

public enum DrainMode
extends java.lang.Enum<DrainMode>

Defines the type of drain operation.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT This mode signifies the default behavior of the drain operation.

Method Summary

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

DEFAULT

public static final DrainMode DEFAULT

This mode signifies the default behavior of the drain operation. All intermediate streams and any samza managed state will be drained and the pipeline will be gracefully shutdown as a result. User state will not be drained.

Method Detail

values

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

Returns:

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

valueOf

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