Package com.seibel.distanthorizons.api.enums.config

Enum Class EDhApiDataCompressionMode

java.lang.Object

java.lang.Enum<EDhApiDataCompressionMode>

com.seibel.distanthorizons.api.enums.config.EDhApiDataCompressionMode

All Implemented Interfaces:

Serializable, Comparable<EDhApiDataCompressionMode>, Constable

public enum EDhApiDataCompressionMode
extends Enum<EDhApiDataCompressionMode>

UNCOMPRESSED
LZ4
XZ

Note: speed and compression ratios are examples and should only be used for estimated comparisons.

Since:

API 2.0.0

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
LZ4	Extremely fast (often faster than uncompressed), but generally poor compression.
LZMA2	Extremely slow, but very good compression.
UNCOMPRESSED	Should only be used internally and for unit testing.

Field Summary

Fields

Modifier and Type	Field	Description
final byte	value	More stable than using the ordinal of the enum

Method Summary

Modifier and Type	Method	Description
static EDhApiDataCompressionMode	getFromValue(byte value)
static EDhApiDataCompressionMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EDhApiDataCompressionMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNCOMPRESSED

public static final EDhApiDataCompressionMode UNCOMPRESSED

Should only be used internally and for unit testing.

Read Speed: 1.64 MS / DTO
Write Speed: 12.44 MS / DTO
Compression ratio: 1.0

LZ4

public static final EDhApiDataCompressionMode LZ4

Extremely fast (often faster than uncompressed), but generally poor compression.

Read Speed: 1.85 MS / DTO
Write Speed: 9.46 MS / DTO
Compression ratio: 0.3638

LZMA2

public static final EDhApiDataCompressionMode LZMA2

Extremely slow, but very good compression.

Read Speed: 12.25 MS / DTO
Write Speed: 490.07 MS / DTO
Compression ratio: 0.1242

Field Details

value

public final byte value

More stable than using the ordinal of the enum

Method Details

values

public static EDhApiDataCompressionMode[] values()

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

Returns:

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

valueOf

public static EDhApiDataCompressionMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getFromValue

public static EDhApiDataCompressionMode getFromValue(byte value)
                                              throws IllegalArgumentException

Throws:

IllegalArgumentException - if the value doesn't map to a value