Package org.pgpainless.algorithm
Enum Class CompressionAlgorithm
- All Implemented Interfaces:
Serializable
,Comparable<CompressionAlgorithm>
,Constable
Enumeration of possible compression algorithms.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum Constants -
Method Summary
Modifier and TypeMethodDescriptionstatic CompressionAlgorithm
fromId
(int id) Return theCompressionAlgorithm
value that corresponds to the provided numerical id.int
Return the numerical algorithm tag corresponding to this compression algorithm.static CompressionAlgorithm
requireFromId
(int id) Return theCompressionAlgorithm
value that corresponds to the provided numerical id.static CompressionAlgorithm
Returns the enum constant of this class with the specified name.static CompressionAlgorithm[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
UNCOMPRESSED
-
ZIP
-
ZLIB
-
BZIP2
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
fromId
Return theCompressionAlgorithm
value that corresponds to the provided numerical id. If an invalid id is provided, null is returned.- Parameters:
id
- id- Returns:
- compression algorithm
-
requireFromId
Return theCompressionAlgorithm
value that corresponds to the provided numerical id. If an invalid id is provided, thrown anNoSuchElementException
.- Parameters:
id
- id- Returns:
- compression algorithm
- Throws:
NoSuchElementException
- in case of an unmapped id
-
getAlgorithmId
public int getAlgorithmId()Return the numerical algorithm tag corresponding to this compression algorithm.- Returns:
- id
-