org.openexi.proc.common
Enum AlignmentType

java.lang.Object
  java.lang.Enum<AlignmentType>
      org.openexi.proc.common.AlignmentType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AlignmentType>

public enum AlignmentType
extends java.lang.Enum<AlignmentType>

AlignmentType represents one of the following bit alignment styles so as to provide an extra degree of control over the way information is stored in EXI format.

• bitPacked is the default setting. Data are stored in the fewest number of bits in sequential streams that cross byte barriers. Conceptually, 8 boolean values might be stored in a single byte, for example.


• byteAligned stores data using EXI tags with byte barriers intact. Byte-aligned files are useful for troubleshooting, because the data are often human-readable when the values are literally encoded as strings. It is not meant for data transfer, as the file has not been optimized.


• preCompress is a byte-aligned format that arranges the data into channels. It is intended for use cases where file compression is part of the transfer process, so as not to perform the compression step twice.


• compress is not a bit alignment in and of itself, but the Deflate algorithm requires that files be byte-aligned. When compression is selected, byte-alignment is used, the data are arranged in channels, and the file is compressed at the end of processing.

Enum Constant Summary

bitPacked

byteAligned

compress

preCompress

Method Summary

static AlignmentType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AlignmentType[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

bitPacked

public static final AlignmentType bitPacked

byteAligned

public static final AlignmentType byteAligned

preCompress

public static final AlignmentType preCompress

compress

public static final AlignmentType compress

Method Detail

values

public static final AlignmentType[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(AlignmentType c : AlignmentType.values())
        System.out.println(c);

Returns:

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

valueOf

public static AlignmentType valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name