com.siemens.ct.exi.core

Enum CodingMode

java.lang.Object

java.lang.Enum<CodingMode>

com.siemens.ct.exi.core.CodingMode

All Implemented Interfaces:

Serializable, Comparable<CodingMode>

public enum CodingMode
extends Enum<CodingMode>

The alignment option is used to control the alignment of event codes and content items.

The value is one of bit-packed, byte-alignment, pre-compression, or compression.

Author:

Daniel.Peintner.EXT@siemens.com, Richard.Kuntschke@siemens.com

Enum Constant Summary

Enum Constants

Enum Constant and Description
BIT_PACKED Alignment option value bit-packed indicates that the the event codes and associated content are packed in bits without any paddings in-between.
BYTE_PACKED Alignment option value byte-alignment indicates that the event codes and associated content are aligned on byte boundaries.
COMPRESSION The compression option is used to increase compactness using additional computational resources (DEFLATE algorithm).
PRE_COMPRESSION Alignment option value pre-compression alignment indicates that all steps involved in compression are to be done with the exception of the final step of applying the DEFLATE algorithm.

Method Summary

Modifier and Type	Method and Description
static CodingMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static CodingMode[]	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

BIT_PACKED

public static final CodingMode BIT_PACKED

Alignment option value bit-packed indicates that the the event codes and associated content are packed in bits without any paddings in-between.

BYTE_PACKED

public static final CodingMode BYTE_PACKED

Alignment option value byte-alignment indicates that the event codes and associated content are aligned on byte boundaries. While byte-alignment generally results in EXI streams of larger sizes compared with their bit-packed equivalents, byte-alignment may provide a help in some use cases that involve frequent copying of large arrays of scalar data directly out of the stream. It can also make it possible to work with data in-place and can make it easier to debug encoded data by allowing items on aligned boundaries to be easily located in the stream.

PRE_COMPRESSION

public static final CodingMode PRE_COMPRESSION

Alignment option value pre-compression alignment indicates that all steps involved in compression are to be done with the exception of the final step of applying the DEFLATE algorithm.

COMPRESSION

public static final CodingMode COMPRESSION

The compression option is used to increase compactness using additional computational resources (DEFLATE algorithm).

Method Detail

values

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

Returns:

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

valueOf

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