Package discord4j.core.object.entity

Enum Class Role.Flag

java.lang.Object

java.lang.Enum<Role.Flag>

discord4j.core.object.entity.Role.Flag

All Implemented Interfaces:

Serializable, Comparable<Role.Flag>, Constable

Enclosing class:

Role

public static enum Role.Flag
extends Enum<Role.Flag>

Describes the flags of a Role.

See Also:

• Discord

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
IN_PROMPT	Role can be selected by members in an onboarding prompt

Method Summary

Modifier and Type	Method	Description
int	getFlag()	Gets the flag value as represented by Discord.
int	getValue()	Gets the underlying value as represented by Discord.
static EnumSet<Role.Flag>	of(int value)	Gets the flags of a role.
static Role.Flag	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Role.Flag[]	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

IN_PROMPT

public static final Role.Flag IN_PROMPT

Role can be selected by members in an onboarding prompt

Method Details

values

public static Role.Flag[] 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 Role.Flag 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.

getFlag

public int getFlag()

Gets the flag value as represented by Discord.

Returns:

The flag value as represented by Discord.

of

public static EnumSet<Role.Flag> of(int value)

Gets the flags of a role. It is guaranteed that invoking getValue() from the returned enum will be equal (==) to the supplied value.

Parameters:

value - The flags value as represented by Discord.

Returns:

The EnumSet of flags.