org.rcsb.mmtf.codec

Enum StringCodecs

java.lang.Object

java.lang.Enum<StringCodecs>

org.rcsb.mmtf.codec.StringCodecs

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<StringCodecs>, CodecInterface, StringCodecsInterface

public enum StringCodecs
extends java.lang.Enum<StringCodecs>
implements StringCodecsInterface, CodecInterface

An enum defining the string encoding and decoding strategies.

Author:

Anthony Bradley

Enum Constant Summary

Enum Constants

Enum Constant and Description
ENCOODE_CHAINS Encode an array of Strings to a byte array.

Method Summary

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

decode, encode

Enum Constant Detail

ENCOODE_CHAINS

public static final StringCodecs ENCOODE_CHAINS

Encode an array of Strings to a byte array. Each String should be less than five characters long.

Method Detail

values

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

Returns:

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

valueOf

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

java.lang.NullPointerException - if the argument is null

getCodec

public static StringCodecs getCodec(int codecId)

Decode a byte array from an input array.

Parameters:

codecId - the int specifying the encoding strategy

Returns:

the decoded array as a String array

decodeArr

public static java.lang.String[] 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 java.lang.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.