discord4j.core.object

Enum PermissionOverwrite.Type

java.lang.Object

java.lang.Enum<PermissionOverwrite.Type>

discord4j.core.object.PermissionOverwrite.Type

All Implemented Interfaces:

Serializable, Comparable<PermissionOverwrite.Type>

Enclosing class:

PermissionOverwrite

public static enum PermissionOverwrite.Type
extends Enum<PermissionOverwrite.Type>

The type of entity a PermissionOverwrite is for.

Enum Constant Summary

Enum Constants

Enum Constant and Description
MEMBER The Member entity.
ROLE The Role entity.
UNKNOWN Unknown type.

Method Summary

Modifier and Type	Method and Description
String	getValue() Gets the underlying value as represented by Discord.
static PermissionOverwrite.Type	of(String value) Gets the type of permission overwrite.
static PermissionOverwrite.Type	valueOf(String name) Returns the enum constant of this type with the specified name.
static PermissionOverwrite.Type[]	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

UNKNOWN

public static final PermissionOverwrite.Type UNKNOWN

Unknown type.

ROLE

public static final PermissionOverwrite.Type ROLE

The Role entity.

MEMBER

public static final PermissionOverwrite.Type MEMBER

The Member entity.

Method Detail

values

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

Returns:

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

valueOf

public static PermissionOverwrite.Type 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 String getValue()

Gets the underlying value as represented by Discord.

Returns:

The underlying value as represented by Discord.

of

public static PermissionOverwrite.Type of(String value)

Gets the type of permission overwrite. It is guaranteed that invoking getValue() from the returned enum will equal (Enum.equals(Object)) the supplied value.

Parameters:

value - The underlying value as represented by Discord.

Returns:

The type of permission overwrite.