picard.sam.SamErrorMetric

Enum ReadBaseStratification.CycleBin

java.lang.Object

java.lang.Enum<ReadBaseStratification.CycleBin>

picard.sam.SamErrorMetric.ReadBaseStratification.CycleBin

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ReadBaseStratification.CycleBin>

Enclosing class:

ReadBaseStratification

public static enum ReadBaseStratification.CycleBin
extends java.lang.Enum<ReadBaseStratification.CycleBin>

An enum designed to hold a binned version of any probability-like number (between 0 and 1) in quintiles

Enum Constant Summary

Enum Constants

Enum Constant and Description
QUINTILE_1
QUINTILE_2
QUINTILE_3
QUINTILE_4
QUINTILE_5

Method Summary

Modifier and Type	Method and Description
static ReadBaseStratification.CycleBin	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ReadBaseStratification.CycleBin[]	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

Enum Constant Detail

QUINTILE_1

public static final ReadBaseStratification.CycleBin QUINTILE_1

QUINTILE_2

public static final ReadBaseStratification.CycleBin QUINTILE_2

QUINTILE_3

public static final ReadBaseStratification.CycleBin QUINTILE_3

QUINTILE_4

public static final ReadBaseStratification.CycleBin QUINTILE_4

QUINTILE_5

public static final ReadBaseStratification.CycleBin QUINTILE_5

Method Detail

values

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

Returns:

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

valueOf

public static ReadBaseStratification.CycleBin 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