Package org.apache.kafka.common

Enum Class CellState

java.lang.Object

java.lang.Enum<CellState>

org.apache.kafka.common.CellState

All Implemented Interfaces:

Serializable, Comparable<CellState>, Constable

public enum CellState
extends Enum<CellState>

Represents the state of a cell, mostly indicating whether tenants can be moved in or out of a cell.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EXCLUDED	Tenants cannot be moved in but can be moved out of the cell
QUARANTINED	Tenants cannot be moved in and out of the cell
READY	Tenants can be moved in and out of the cell
UNKNOWN	A cell is never in an UNKNOWN state, but a client can pass a state that is UNKNOWN which fails during validation.

Field Summary

Fields

Modifier and Type	Field	Description
static final Set<CellState>	VALID_CELL_STATES

Method Summary

Modifier and Type	Method	Description
byte	code()
boolean	isEligibleDestination()
boolean	isEligibleSource()
static CellState	toEnum(byte code)
static CellState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CellState[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNKNOWN

public static final CellState UNKNOWN

A cell is never in an UNKNOWN state, but a client can pass a state that is UNKNOWN which fails during validation.

READY

public static final CellState READY

Tenants can be moved in and out of the cell

QUARANTINED

public static final CellState QUARANTINED

Tenants cannot be moved in and out of the cell

EXCLUDED

public static final CellState EXCLUDED

Tenants cannot be moved in but can be moved out of the cell

Field Details

VALID_CELL_STATES

public static final Set<CellState> VALID_CELL_STATES

Method Details

values

public static CellState[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static CellState valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

code

public byte code()

isEligibleSource

public boolean isEligibleSource()

isEligibleDestination

public boolean isEligibleDestination()

toEnum

public static CellState toEnum(byte code)