Enum PermissionLevel

java.lang.Object
java.lang.Enum<PermissionLevel>
com.github.alex1304.ultimategdbot.api.command.PermissionLevel
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<PermissionLevel>, java.lang.constant.Constable

public enum PermissionLevel
extends java.lang.Enum<PermissionLevel>
Permission level of a bot command.
  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>
  • Enum Constant Summary

    Enum Constants 
    Enum Constant Description
    BOT_ADMIN  
    BOT_OWNER  
    PUBLIC  
    SERVER_ADMIN  
    SERVER_MOD  
  • Method Summary

    Modifier and Type Method Description
    reactor.core.publisher.Mono<java.lang.Void> checkGranted​(Context ctx)
    Completes empty if the permission is granted in the given context, or errors with PermissionDeniedException otherwise.
    reactor.core.publisher.Mono<java.lang.Boolean> isGranted​(Context ctx)
    Emits true if the permission is granted in the given context, false otherwise.
    static PermissionLevel valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static PermissionLevel[] 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, 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

  • Method Details

    • values

      public static PermissionLevel[] 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 PermissionLevel 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
    • isGranted

      public reactor.core.publisher.Mono<java.lang.Boolean> isGranted​(Context ctx)
      Emits true if the permission is granted in the given context, false otherwise.
      Parameters:
      ctx - the context
      Returns:
      a Mono emitting a boolean value
    • checkGranted

      public reactor.core.publisher.Mono<java.lang.Void> checkGranted​(Context ctx)
      Completes empty if the permission is granted in the given context, or errors with PermissionDeniedException otherwise.
      Parameters:
      ctx - the context
      Returns:
      a Mono completing empty or with an error if not granted