Package discord4j.core.object.entity.channel

Enum Class Channel.Flag

java.lang.Object

java.lang.Enum<Channel.Flag>

discord4j.core.object.entity.channel.Channel.Flag

All Implemented Interfaces:

Serializable, Comparable<Channel.Flag>, Constable

Enclosing interface:

Channel

@Experimental
public static enum Channel.Flag
extends Enum<Channel.Flag>

Represent channel flags : https://discord.com/developers/docs/resources/channel#channel-object-channel-flags

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
PINNED	This ThreadChannel is pinned to the top of its parent ForumChannel
REQUIRE_TAG	Whether a tag is required to be specified when creating a ThreadChannel in a ForumChannel.

Method Summary

Modifier and Type	Method	Description
int	getBitValue()	Gets the bit value associated to this flag
int	getShiftValue()	Gets the shift amount associated to this bit value
static int	toBitfield(EnumSet<Channel.Flag> flags)	Translates an EnumSet<Channel.Flag> to a binary bitfield
static EnumSet<Channel.Flag>	valueOf(int bitfield)	Translate a bitfield value into an < ForumChannelFlag > related to known flags
static Channel.Flag	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Channel.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

PINNED

public static final Channel.Flag PINNED

This ThreadChannel is pinned to the top of its parent ForumChannel

REQUIRE_TAG

public static final Channel.Flag REQUIRE_TAG

Whether a tag is required to be specified when creating a ThreadChannel in a ForumChannel. Tags are specified in the applied_tags field.

Method Details

values

public static Channel.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 Channel.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

getShiftValue

public int getShiftValue()

Gets the shift amount associated to this bit value

Returns:

N in 1 << N that is the bit value for this flag

getBitValue

public int getBitValue()

Gets the bit value associated to this flag

Returns:

The bit field value associated to this flag

valueOf

public static EnumSet<Channel.Flag> valueOf(int bitfield)

Translate a bitfield value into an < ForumChannelFlag > related to known flags

Parameters:

bitfield - An integer representing the flags, one per bit

Returns:

An EnumSet<Channel.Flag> of known flags associated to this bit field

Implementation Note:

This implementation ignores unknown flags

toBitfield

public static int toBitfield(EnumSet<Channel.Flag> flags)

Translates an EnumSet<Channel.Flag> to a binary bitfield

Parameters:

flags - Set of known forum channel flags

Returns:

An integer representing the given set as an integer