org.rcsb.mmtf.codec

Enum IntCodecs

java.lang.Object

java.lang.Enum<IntCodecs>

org.rcsb.mmtf.codec.IntCodecs

All Implemented Interfaces:

Serializable, Comparable<IntCodecs>, CodecInterface, IntCodecInterface

public enum IntCodecs
extends Enum<IntCodecs>
implements IntCodecInterface, CodecInterface

Codecs for Integer encoding and decoding.

Author:

Anthony Bradley

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONVERT_4_BYTE Convert integers to a byte array - encoding each integer as a four byte integer.
CONVERT_BYTE Convert integers to a byte array - encoding each integer as a one byte integer.
RUN_LENGTH_DELTA Encoding first performs delta encoding and then run length encoding on top.

Method Summary

Modifier and Type	Method and Description
static int[]	decodeArr(byte[] inputData) Decode a byte array from an input array.
static IntCodecs	getCodec(int codecId) Get the codec from an input byte.
int	getCodecId()
String	getCodecName()
static IntCodecs	valueOf(String name) Returns the enum constant of this type with the specified name.
static IntCodecs[]	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

Methods inherited from interface org.rcsb.mmtf.codec.IntCodecInterface

decode, encode

Enum Constant Detail

RUN_LENGTH_DELTA

public static final IntCodecs RUN_LENGTH_DELTA

Encoding first performs delta encoding and then run length encoding on top. This is appropriate for serial numbers. 1,2,3,4,5,6 go to 1,1,1,1,1,1 go to 1,6

CONVERT_4_BYTE

public static final IntCodecs CONVERT_4_BYTE

Convert integers to a byte array - encoding each integer as a four byte integer.

CONVERT_BYTE

public static final IntCodecs CONVERT_BYTE

Convert integers to a byte array - encoding each integer as a one byte integer.

Method Detail

values

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

Returns:

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

valueOf

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

getCodec

public static IntCodecs getCodec(int codecId)

Get the codec from an input byte.

Parameters:

codecId - the byte defining the coding

Returns:

the enum of the codec

decodeArr

public static int[] decodeArr(byte[] inputData)

Decode a byte array from an input array.

Parameters:

inputData - the byte array of data

Returns:

the decoded array as a int array

getCodecName

public String getCodecName()

Specified by:

getCodecName in interface CodecInterface

Returns:

the codec name - a string naming the codec

getCodecId

public int getCodecId()

Specified by:

getCodecId in interface CodecInterface

Returns:

the codecId a short for the codec