discord4j.core.object.entity

Enum Guild.SystemChannelFlag

java.lang.Object

java.lang.Enum<Guild.SystemChannelFlag>

discord4j.core.object.entity.Guild.SystemChannelFlag

All Implemented Interfaces:

Serializable, Comparable<Guild.SystemChannelFlag>

Enclosing class:

Guild

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

Describes system channel flags.

Enum Constant Summary

Enum Constants

Enum Constant and Description
SUPPRESS_JOIN_NOTIFICATIONS Member join notifications are suppressed.
SUPPRESS_PREMIUM_SUBSCRIPTIONS Server boost notifications are suppressed.

Method Summary

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

SUPPRESS_JOIN_NOTIFICATIONS

public static final Guild.SystemChannelFlag SUPPRESS_JOIN_NOTIFICATIONS

Member join notifications are suppressed.

SUPPRESS_PREMIUM_SUBSCRIPTIONS

public static final Guild.SystemChannelFlag SUPPRESS_PREMIUM_SUBSCRIPTIONS

Server boost notifications are suppressed.

Method Detail

values

public static Guild.SystemChannelFlag[] 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 (Guild.SystemChannelFlag c : Guild.SystemChannelFlag.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Guild.SystemChannelFlag valueOf(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:

IllegalArgumentException - if this enum type 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<Guild.SystemChannelFlag> of(int value)

Gets the flags of system channel. 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.