Package net.dv8tion.jda.api.utils
Enum Compression
- java.lang.Object
-
- java.lang.Enum<Compression>
-
- net.dv8tion.jda.api.utils.Compression
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<Compression>
public enum Compression extends java.lang.Enum<Compression>
Compression algorithms that can be used with JDA.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getKey()
The key used for the gateway query to enable this compressionstatic Compression
valueOf(java.lang.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.
-
-
-
Enum Constant Detail
-
NONE
public static final Compression NONE
Don't use any compression
-
ZLIB
public static final Compression ZLIB
Use ZLIB transport compression
-
-
Method Detail
-
values
public static Compression[] 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 (Compression c : Compression.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static Compression valueOf(java.lang.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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
getKey
public java.lang.String getKey()
The key used for the gateway query to enable this compression- Returns:
- The query key
-
-