org.apache.curator.framework.recipes.leader

Enum LeaderLatch.CloseMode

java.lang.Object

java.lang.Enum<LeaderLatch.CloseMode>

org.apache.curator.framework.recipes.leader.LeaderLatch.CloseMode

All Implemented Interfaces:

Serializable, Comparable<LeaderLatch.CloseMode>

Enclosing class:

LeaderLatch

public static enum LeaderLatch.CloseMode
extends Enum<LeaderLatch.CloseMode>

How to handle listeners when the latch is closed

Enum Constant Summary

Enum Constants

Enum Constant and Description
NOTIFY_LEADER When the latch is closed, listeners *will* be notified
SILENT When the latch is closed, listeners will *not* be notified (default behavior)

Method Summary

Methods

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

SILENT

public static final LeaderLatch.CloseMode SILENT

When the latch is closed, listeners will *not* be notified (default behavior)

NOTIFY_LEADER

public static final LeaderLatch.CloseMode NOTIFY_LEADER

When the latch is closed, listeners *will* be notified

Method Detail

values

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

Returns:

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

valueOf

public static LeaderLatch.CloseMode 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