Package org.javacord.api.entity.server

Enum BoostLevel

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<BoostLevel>
    public enum BoostLevel
extends java.lang.Enum<BoostLevel>
    An enum with all boost levels (sometimes also referred to as premium tier levels).

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      NONE
      Server has no boost level.
      TIER_1
      Server Boost level 1.
      TIER_2
      Server Boost level 2.
      TIER_3
      Server Boost level 3.
      UNKNOWN
      An unknown boost level, most likely due to new added boost levels.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static BoostLevel fromId​(int id)
      Gets the boost level by its id.
      int getId()
      Gets the id of the boost level.
      static BoostLevel valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static BoostLevel[] 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

      • NONE

        public static final BoostLevel NONE
        Server has no boost level.

      • TIER_1

        public static final BoostLevel TIER_1
        Server Boost level 1.

      • TIER_2

        public static final BoostLevel TIER_2
        Server Boost level 2.

      • TIER_3

        public static final BoostLevel TIER_3
        Server Boost level 3.

      • UNKNOWN

        public static final BoostLevel UNKNOWN
        An unknown boost level, most likely due to new added boost levels.

    • Method Detail

      • values

        public static BoostLevel[] 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 (BoostLevel c : BoostLevel.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

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

      • getId

        public int getId()
        Gets the id of the boost level.
        Returns:
        The id of the boost level.

      • fromId

        public static BoostLevel fromId​(int id)
        Gets the boost level by its id.
        Parameters:
        id - The id of the boost level.
        Returns:
        The boost level with the given id.