picard.sam.SamErrorMetric

Enum ReadBaseStratification.ReadDirection

java.lang.Object

java.lang.Enum<ReadBaseStratification.ReadDirection>

picard.sam.SamErrorMetric.ReadBaseStratification.ReadDirection

All Implemented Interfaces:

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

Enclosing class:

ReadBaseStratification

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

An enum for holding the direction for a read (positive strand or negative strand

Enum Constant Summary

Enum Constants

Enum Constant and Description
NEGATIVE
POSITIVE

Method Summary

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

POSITIVE

public static final ReadBaseStratification.ReadDirection POSITIVE

NEGATIVE

public static final ReadBaseStratification.ReadDirection NEGATIVE

Method Detail

values

public static ReadBaseStratification.ReadDirection[] 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.ReadDirection c : ReadBaseStratification.ReadDirection.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.ReadDirection 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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<ReadBaseStratification.ReadDirection>

of

public static ReadBaseStratification.ReadDirection of(htsjdk.samtools.SAMRecord sam)