Package org.apache.cassandra.streaming

Enum Class StreamSession.State

java.lang.Object

java.lang.Enum<StreamSession.State>

org.apache.cassandra.streaming.StreamSession.State

All Implemented Interfaces:

Serializable, Comparable<StreamSession.State>, Constable

Enclosing class:

StreamSession

public static enum StreamSession.State
extends Enum<StreamSession.State>

State Transition:

  +------------------+-----> FAILED | ABORTED <---------------+
  |                  |              ^                         |
  |                  |              |       initiator         |
  INITIALIZED --> PREPARING --> STREAMING ------------> WAIT_COMPLETE ----> COMPLETED
  |                  |              |                         ^                 ^
  |                  |              |       follower          |                 |
  |                  |              +-------------------------)-----------------+
  |                  |                                        |                 |
  |                  |         if preview                     |                 |
  |                  +----------------------------------------+                 |
  |               nothing to request or to transfer                             |
  +-----------------------------------------------------------------------------+
                  nothing to request or to transfer

  

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
ABORTED
COMPLETE
FAILED
INITIALIZED
PREPARING
STREAMING
WAIT_COMPLETE

Method Summary

Modifier and Type	Method	Description
boolean	isFinalState()
static StreamSession.State	valueOf(String name)	Returns the enum constant of this class with the specified name.
static StreamSession.State[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INITIALIZED

public static final StreamSession.State INITIALIZED

PREPARING

public static final StreamSession.State PREPARING

STREAMING

public static final StreamSession.State STREAMING

WAIT_COMPLETE

public static final StreamSession.State WAIT_COMPLETE

COMPLETE

public static final StreamSession.State COMPLETE

FAILED

public static final StreamSession.State FAILED

ABORTED

public static final StreamSession.State ABORTED

Method Details

values

public static StreamSession.State[] 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 StreamSession.State 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

isFinalState

public boolean isFinalState()

Returns:

true if current state is final, either COMPLETE, FAILED, or ABORTED.