Package discord4j.core.object.entity

Enum Class Guild.PremiumTier

java.lang.Object

java.lang.Enum<Guild.PremiumTier>

discord4j.core.object.entity.Guild.PremiumTier

All Implemented Interfaces:

Serializable, Comparable<Guild.PremiumTier>, Constable

Enclosing class:

Guild

public static enum Guild.PremiumTier
extends Enum<Guild.PremiumTier>

Represent the server Premium Tier (aka boost level) of the Guild.

See Also:

• Server Boost info
• Premium Tier docs

Nested Class Summary

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
NONE	No Premium Tier.
TIER_1	Premium Tier 1 (Boost Level 1).
TIER_2	Premium Tier 2 (Boost Level 2).
TIER_3	Premium Tier 3 (Boost Level 3).
UNKNOWN	Unknown Premium Tier.

Method Summary

Modifier and Type	Method	Description
int	getValue()	Gets the underlying value as represented by Discord.
static Guild.PremiumTier	of(int value)	Gets the Premium Tier (aka boost level) of the Guild.
static Guild.PremiumTier	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Guild.PremiumTier[]	values()	Returns an array containing the constants of this enum class, 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

UNKNOWN

public static final Guild.PremiumTier UNKNOWN

Unknown Premium Tier.

NONE

public static final Guild.PremiumTier NONE

No Premium Tier.

TIER_1

public static final Guild.PremiumTier TIER_1

Premium Tier 1 (Boost Level 1).

TIER_2

public static final Guild.PremiumTier TIER_2

Premium Tier 2 (Boost Level 2).

TIER_3

public static final Guild.PremiumTier TIER_3

Premium Tier 3 (Boost Level 3).

Method Details

values

public static Guild.PremiumTier[] 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 Guild.PremiumTier 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

getValue

public int getValue()

Gets the underlying value as represented by Discord.

Returns:

The underlying value as represented by Discord.

of

public static Guild.PremiumTier of(int value)

Gets the Premium Tier (aka boost level) of the Guild. It is guaranteed that invoking getValue() from the returned enum will equal (==) the supplied value.

Parameters:

value - The underlying value as represented by Discord.

Returns:

The Premium Tier (aka boost level) of the {Guild.