Package net.dv8tion.jda.api.utils

Enum Compression

java.lang.Object

java.lang.Enum<Compression>

net.dv8tion.jda.api.utils.Compression

All Implemented Interfaces:

Serializable, Comparable<Compression>

public enum Compression
extends Enum<Compression>

Compression algorithms that can be used with JDA.

See Also:

• JDABuilder.setCompression(Compression)
• DefaultShardManagerBuilder.setCompression(Compression)

Enum Constant Summary

Enum Constants

Enum Constant	Description
NONE	Don't use any compression
ZLIB	Use ZLIB transport compression

Method Summary

Modifier and Type	Method	Description
String	getKey()	The key used for the gateway query to enable this compression
static Compression	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Compression[]	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

NONE

public static final Compression NONE

Don't use any compression

ZLIB

public static final Compression ZLIB

Use ZLIB transport compression

Method Details

values

public static Compression[] 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 Compression 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

getKey

@Nonnull
public String getKey()

The key used for the gateway query to enable this compression

Returns:

The query key