org.broadinstitute.hellbender.utils

Enum Tail

java.lang.Object

java.lang.Enum<Tail>

org.broadinstitute.hellbender.utils.Tail

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Tail>

public enum Tail
extends java.lang.Enum<Tail>

Enum for two-sided things, for example which end of a read has been clipped, which end of a chain within an assembly graph etc.

Enum Constant Summary

Enum Constants

Enum Constant and Description
LEFT
RIGHT

Method Summary

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

LEFT

public static final Tail LEFT

RIGHT

public static final Tail RIGHT

Method Detail

values

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

Returns:

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

valueOf

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