Package org.incendo.cloud.state

Enum RegistrationState

java.lang.Object
java.lang.Enum<RegistrationState>
org.incendo.cloud.state.RegistrationState
All Implemented Interfaces:
Serializable, Comparable<RegistrationState>, State
@API(status=STABLE) public enum RegistrationState extends Enum<RegistrationState> implements State
The point in the registration lifecycle for this commands manager

  • Enum Constant Details

    • BEFORE_REGISTRATION

      public static final RegistrationState BEFORE_REGISTRATION
      The point when no commands have been registered yet.

      At this point, all configuration options can be changed.

    • REGISTERING

      public static final RegistrationState REGISTERING
      When at least one command has been registered, and more commands have been registered.

      In this state, some options that affect how commands are registered with the platform are frozen. Some platforms will remain in this state for their lifetime.

    • AFTER_REGISTRATION

      public static final RegistrationState AFTER_REGISTRATION
      Once registration has been completed.

      At this point, the command manager is effectively immutable. On platforms where command registration happens via callback, this state is achieved the first time the manager's callback is executed for registration.

  • Method Details

    • values

      public static RegistrationState[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

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