Package net.dv8tion.jda.api.entities.sticker

Enum Sticker.StickerFormat

java.lang.Object

java.lang.Enum<Sticker.StickerFormat>

net.dv8tion.jda.api.entities.sticker.Sticker.StickerFormat

All Implemented Interfaces:

Serializable, Comparable<Sticker.StickerFormat>

Enclosing interface:

Sticker

public static enum Sticker.StickerFormat
extends Enum<Sticker.StickerFormat>

The various formats used for stickers and the respective file extensions.

Enum Constant Summary

Enum Constants

Enum Constant	Description
APNG	The APNG format.
GIF	The GIF format.
LOTTIE	The LOTTIE format.
PNG	The PNG format.
UNKNOWN	Represents any unknown or unsupported format types.

Method Summary

Modifier and Type	Method	Description
static Sticker.StickerFormat	fromId(int id)	Resolves the specified format identifier to the StickerFormat enum constant.
String	getExtension()	The file extension used for the sticker asset.
static Sticker.StickerFormat	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Sticker.StickerFormat[]	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 Details

PNG

public static final Sticker.StickerFormat PNG

The PNG format.

APNG

public static final Sticker.StickerFormat APNG

The APNG format.

LOTTIE

public static final Sticker.StickerFormat LOTTIE

The LOTTIE format.
Lottie isn't a standard renderable image. It is a JSON with data that can be rendered using the lottie library.

See Also:

• Lottie website

GIF

public static final Sticker.StickerFormat GIF

The GIF format.

UNKNOWN

public static final Sticker.StickerFormat UNKNOWN

Represents any unknown or unsupported format types.

Method Details

values

public static Sticker.StickerFormat[] values()

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

Returns:

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

valueOf

public static Sticker.StickerFormat 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

getExtension

@Nonnull
public String getExtension()

The file extension used for the sticker asset.

Returns:

The file extension for this format

Throws:

IllegalStateException - If the StickerFormat is UNKNOWN

fromId

@Nonnull
public static Sticker.StickerFormat fromId(int id)

Resolves the specified format identifier to the StickerFormat enum constant.

Parameters:

id - The id for this format

Returns:

The representative StickerFormat or UNKNOWN if it can't be resolved