Enum Class ChatPluginState

java.lang.Object
java.lang.Enum<ChatPluginState>
me.remigio07.chatplugin.api.common.util.ChatPluginState
All Implemented Interfaces:
Serializable, Comparable<ChatPluginState>, Constable

public enum ChatPluginState extends Enum<ChatPluginState>
Represents the plugin's state.
See Also:
  • Enum Constant Details

    • NOT_STARTED_YET

      public static final ChatPluginState NOT_STARTED_YET
      Initial state, when the server has not started loading it yet.

      Warning: no operations involving ChatPlugin should be executed at this moment.

    • STARTING

      public static final ChatPluginState STARTING
      Starting state, when the plugin is either:
      • being started during a server startup or /bukkit:reload
      • being restarted after an attempt of recovery caused by a failed ChatPlugin.reload()

      Warning: operations involving ChatPlugin may be executed at this moment, however there are no guarantees on the behaviour of its modules.

    • RELOADING

      public static final ChatPluginState RELOADING
      Reloading state, when a ChatPlugin.reload() is being performed.

      Warning: operations involving ChatPlugin may be executed at this moment, however there are no guarantees on the behaviour of its modules.

    • LOADED

      public static final ChatPluginState LOADED
      Ordinary execution state, when the plugin is correctly working with (hopefully) no issues.

      Generally, operations involving ChatPlugin should be executed in this period of time.

    • UNLOADING

      public static final ChatPluginState UNLOADING
      Unloading state, when the plugin is either:
      • being disabled during a server shutdown or /bukkit:reload
      • being unloaded after a failed ChatPlugin.reload()

      Warning: operations involving ChatPlugin may be executed at this moment, however there are no guarantees on the behaviour of its modules.

    • UNLOADED

      public static final ChatPluginState UNLOADED
      Unloaded state, when ChatPlugin.unload() has been completed without issues and the plugin has been disabled.

      Warning: no operations involving ChatPlugin should be executed at this moment.

    • RECOVERY

      public static final ChatPluginState RECOVERY
      Recovery mode state, when the plugin fails ChatPlugin.reload() or ChatPlugin.unload().

      Warning: no operations involving ChatPlugin should be executed at this moment.

  • Method Details

    • values

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