org.eclipse.californium.scandium.dtls

Enum CompressionMethod

java.lang.Object

java.lang.Enum<CompressionMethod>

org.eclipse.californium.scandium.dtls.CompressionMethod

All Implemented Interfaces:

Serializable, Comparable<CompressionMethod>

public enum CompressionMethod
extends Enum<CompressionMethod>

An identifier for the compression algorithms defined by the IANA to be used with DTLS.

Instances of this enumeration do not implement any compression functionality. They merely serve as an object representation of the identifiers defined in Transport Layer Security Protocol Compression Methods.

Note that only the NULL compression method is supported at the moment.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFLATE
NULL

Field Summary

Fields

Modifier and Type	Field and Description
static int	COMPRESSION_METHOD_BITS

Method Summary

Methods

Modifier and Type	Method and Description
int	getCode()
static CompressionMethod	getMethodByCode(int code)
static List<CompressionMethod>	listFromReader(org.eclipse.californium.elements.util.DatagramReader reader) Takes a reader and creates the representing list of compression methods.
static byte[]	listToByteArray(List<CompressionMethod> compressionMethods) Takes a list of compression methods and creates the representing byte stream.
static CompressionMethod	valueOf(String name) Returns the enum constant of this type with the specified name.
static CompressionMethod[]	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

NULL

public static final CompressionMethod NULL

DEFLATE

public static final CompressionMethod DEFLATE

Field Detail

COMPRESSION_METHOD_BITS

public static final int COMPRESSION_METHOD_BITS

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

getCode

public int getCode()

getMethodByCode

public static CompressionMethod getMethodByCode(int code)

listToByteArray

public static byte[] listToByteArray(List<CompressionMethod> compressionMethods)

Takes a list of compression methods and creates the representing byte stream.

Parameters:

compressionMethods - the list of the compression methods

Returns:

the corresponding byte array

listFromReader

public static List<CompressionMethod> listFromReader(org.eclipse.californium.elements.util.DatagramReader reader)

Takes a reader and creates the representing list of compression methods.

Parameters:

reader - the encoded compression methods as byte array

Returns:

corresponding list of compression methods