org.rcsb.mmtf.codec

Enum CharCodecs

java.lang.Object

java.lang.Enum<CharCodecs>

org.rcsb.mmtf.codec.CharCodecs

All Implemented Interfaces:

Serializable, Comparable<CharCodecs>, CharCodecInterface, CodecInterface

public enum CharCodecs
extends Enum<CharCodecs>
implements CharCodecInterface, CodecInterface

An enum of char codecs.

Author:

Anthony Bradley

Enum Constant Summary

Enum Constants

Enum Constant and Description
RUN_LENGTH Run length codec for an array of chars (using ASCII code) http://www.asciitable.com/.

Method Summary

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

decode, encode

Enum Constant Detail

RUN_LENGTH

public static final CharCodecs RUN_LENGTH

Run length codec for an array of chars (using ASCII code) http://www.asciitable.com/. For example: ["A", "A", "A"] goes to [10,10,10] goest to [10,3].

Method Detail

values

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

Returns:

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

valueOf

public static CharCodecs 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 CharCodecs getCodec(int inputInt)

Get the codec from an input integer.

Parameters:

inputInt - the integer defining the coding

Returns:

the enum of the codec

decodeArr

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

Decode a byte array from an input array.

Parameters:

inputData - the byte array of data

Returns:

the decoded array as a char 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 codec id. currently an integer defining the codec.