Package org.apache.kafka.common

Enum ElectionType

java.lang.Object

java.lang.Enum<ElectionType>

org.apache.kafka.common.ElectionType

All Implemented Interfaces:

Serializable, Comparable<ElectionType>

@Evolving
public enum ElectionType
extends Enum<ElectionType>

Options for Admin.electLeaders(ElectionType, Set, org.apache.kafka.clients.admin.ElectLeadersOptions). The API of this class is evolving, see Admin for details.

Enum Constant Summary

Enum Constants

Enum Constant	Description
PREFERRED
UNCLEAN

Field Summary

Fields

Modifier and Type	Field	Description
byte	value

Method Summary

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

PREFERRED

public static final ElectionType PREFERRED

UNCLEAN

public static final ElectionType UNCLEAN

Field Detail

value

public final byte value

Method Detail

values

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

Returns:

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

valueOf

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

valueOf

public static ElectionType valueOf(byte value)

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:

value - 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