Package cloud.commandframework

Enum CommandManager.ManagerSettings

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ALLOW_UNSAFE_REGISTRATION
      Allow registering commands even when doing so has the potential to produce inconsistent results.
      ENFORCE_INTERMEDIARY_PERMISSIONS
      Do not create a compound permission and do not look greedily for child permission values, if a preceding command in the tree path has a command handler attached
      FORCE_SUGGESTION
      Force sending of an empty suggestion (i.e.
      OVERRIDE_EXISTING_COMMANDS
      Enables overriding of existing commands on supported platforms.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static CommandManager.ManagerSettings valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static CommandManager.ManagerSettings[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

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

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • ENFORCE_INTERMEDIARY_PERMISSIONS

        public static final CommandManager.ManagerSettings ENFORCE_INTERMEDIARY_PERMISSIONS
        Do not create a compound permission and do not look greedily for child permission values, if a preceding command in the tree path has a command handler attached

      • FORCE_SUGGESTION

        public static final CommandManager.ManagerSettings FORCE_SUGGESTION
        Force sending of an empty suggestion (i.e. a singleton list containing an empty string) when no suggestions are present

      • ALLOW_UNSAFE_REGISTRATION

        public static final CommandManager.ManagerSettings ALLOW_UNSAFE_REGISTRATION
        Allow registering commands even when doing so has the potential to produce inconsistent results.

        For example, if a platform serializes the command tree and sends it to clients, this will allow modifying the command tree after it has been sent, as long as these modifications are not blocked by the underlying platform

        Since:
        1.2.0

      • OVERRIDE_EXISTING_COMMANDS

        public static final CommandManager.ManagerSettings OVERRIDE_EXISTING_COMMANDS
        Enables overriding of existing commands on supported platforms.
        Since:
        1.2.0

    • Method Detail

      • values

        public static CommandManager.ManagerSettings[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (CommandManager.ManagerSettings c : CommandManager.ManagerSettings.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static CommandManager.ManagerSettings valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null