Package net.dv8tion.jda.api.entities

Enum Icon.IconType

java.lang.Object

java.lang.Enum<Icon.IconType>

net.dv8tion.jda.api.entities.Icon.IconType

All Implemented Interfaces:

Serializable, Comparable<Icon.IconType>

Enclosing class:

Icon

public static enum Icon.IconType
extends Enum<Icon.IconType>

Supported image types for the Discord API.

Enum Constant Summary

Enum Constants

Enum Constant	Description
GIF	GIF
JPEG	JPEG
PNG	PNG
UNKNOWN	Placeholder for unsupported IconTypes
WEBP	WEBP

Method Summary

Modifier and Type	Method	Description
static Icon.IconType	fromExtension(String extension)	Resolves the provided file extension type to the equivalent IconType.
static Icon.IconType	fromMIME(String mime)	Resolves the provided MIME Type to the equivalent IconType.
String	getHeader()	The data header for the encoding of an image.
String	getMIME()	The MIME Type
static Icon.IconType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Icon.IconType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

JPEG

public static final Icon.IconType JPEG

JPEG

PNG

public static final Icon.IconType PNG

PNG

WEBP

public static final Icon.IconType WEBP

WEBP

GIF

public static final Icon.IconType GIF

GIF

UNKNOWN

public static final Icon.IconType UNKNOWN

Placeholder for unsupported IconTypes

Method Detail

values

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

Returns:

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

valueOf

public static Icon.IconType 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

getMIME

@Nonnull
public String getMIME()

The MIME Type

Returns:

The MIME Type

See Also:

MIME

getHeader

@Nonnull
public String getHeader()

The data header for the encoding of an image.

Returns:

The data header

fromMIME

@Nonnull
public static Icon.IconType fromMIME(@Nonnull
                                     String mime)

Resolves the provided MIME Type to the equivalent IconType.
If the type is not supported, UNKNOWN is returned.

Parameters:

mime - The MIME type

Returns:

The resolved IconType or UNKNOWN.

fromExtension

@Nonnull
public static Icon.IconType fromExtension(@Nonnull
                                          String extension)

Resolves the provided file extension type to the equivalent IconType.
If the type is not supported, UNKNOWN is returned.

Parameters:

extension - The extension type

Returns:

The resolved IconType or UNKNOWN.