Package org.apache.cassandra.utils.progress

Enum Class ProgressEventType

java.lang.Object
java.lang.Enum<ProgressEventType>
org.apache.cassandra.utils.progress.ProgressEventType
All Implemented Interfaces:
Serializable, Comparable<ProgressEventType>, Constable
public enum ProgressEventType extends Enum<ProgressEventType>
Progress event type.

Progress starts by emitting START, followed by emitting zero or more PROGRESS events, then it emits either one of ERROR/ABORT/SUCCESS. Progress indicates its completion by emitting COMPLETE at the end of process.

NOTIFICATION event type is used to just notify message without progress.

  • Enum Constant Details

    • START

      public static final ProgressEventType START
      Fired first when progress starts. Happens only once.

    • PROGRESS

      public static final ProgressEventType PROGRESS
      Fire when progress happens. This can be zero or more time after START.

    • ERROR

      public static final ProgressEventType ERROR
      When observing process completes with error, this is sent once before COMPLETE.

    • ABORT

      public static final ProgressEventType ABORT
      When observing process is aborted by user, this is sent once before COMPLETE.

    • SUCCESS

      public static final ProgressEventType SUCCESS
      When observing process completes successfully, this is sent once before COMPLETE.

    • COMPLETE

      public static final ProgressEventType COMPLETE
      Fire when progress complete. This is fired once, after ERROR/ABORT/SUCCESS is fired. After this, no more ProgressEvent should be fired for the same event.

    • NOTIFICATION

      public static final ProgressEventType NOTIFICATION
      Used when sending message without progress.

  • Method Details

    • values

      public static ProgressEventType[] 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 ProgressEventType 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