Package kmer.core.codecs

Enum Class LongKMerCodec

java.lang.Object

java.lang.Enum<LongKMerCodec>

kmer.core.codecs.LongKMerCodec

All Implemented Interfaces:

Serializable, Comparable<LongKMerCodec>, Constable, KMerCodec<Long>

public enum LongKMerCodec
extends Enum<LongKMerCodec>
implements KMerCodec<Long>

Author:

Dennis Cosgrove

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
INSTANCE

Method Summary

Modifier and Type	Method	Description
byte[]	decode(Long encodedKMer, int k)
Long	encode(byte[] kMer)
static LongKMerCodec	valueOf(String name)	Returns the enum constant of this class with the specified name.
static LongKMerCodec[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INSTANCE

public static final LongKMerCodec INSTANCE

Method Details

values

public static LongKMerCodec[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static LongKMerCodec valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

encode

public Long encode(byte[] kMer)

Specified by:

encode in interface KMerCodec<Long>

decode

public byte[] decode(Long encodedKMer,
 int k)

Specified by:

decode in interface KMerCodec<Long>