Package org.forgerock.json.jose.jwe

Enum CompressionAlgorithm

java.lang.Object

java.lang.Enum<CompressionAlgorithm>

org.forgerock.json.jose.jwe.CompressionAlgorithm

All Implemented Interfaces:

Serializable, Comparable<CompressionAlgorithm>

public enum CompressionAlgorithm
extends Enum<CompressionAlgorithm>

An Enum of the possible compression algorithms that can be applied to the JWE payload plaintext.

Since:

2.0.0

See Also:

JWE Compression Algorithm

Enum Constant Summary

Enum Constants

Enum Constant	Description
DEF	A lossless compressed data format that compresses data using a combination of the LZ77 algorithm and Huffman coding.
NONE	When no compression is applied.

Method Summary

Modifier and Type	Method	Description
static CompressionAlgorithm	parseAlgorithm(String algorithm)	Parses the given algorithm string to find the matching CompressionAlgorithm enum constant.
static CompressionAlgorithm	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CompressionAlgorithm[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final CompressionAlgorithm NONE

When no compression is applied.

DEF

public static final CompressionAlgorithm DEF

A lossless compressed data format that compresses data using a combination of the LZ77 algorithm and Huffman coding.

Method Detail

values

public static CompressionAlgorithm[] 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 (CompressionAlgorithm c : CompressionAlgorithm.values())
    System.out.println(c);

Returns:

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

valueOf

public static CompressionAlgorithm 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

parseAlgorithm

public static CompressionAlgorithm parseAlgorithm(String algorithm)

Parses the given algorithm string to find the matching CompressionAlgorithm enum constant.

Parameters:

algorithm - The compression algorithm.

Returns:

The CompressionAlgorithm enum.