htsjdk.tribble.bed

Enum BEDCodec.StartOffset

java.lang.Object

java.lang.Enum<BEDCodec.StartOffset>

htsjdk.tribble.bed.BEDCodec.StartOffset

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BEDCodec.StartOffset>

Enclosing class:

BEDCodec

public static enum BEDCodec.StartOffset
extends java.lang.Enum<BEDCodec.StartOffset>

Indicate whether co-ordinates or 0-based or 1-based.

Tribble uses 1-based, BED files use 0. e.g.: start_position = bedline_start_position - startIndex.value()

Enum Constant Summary

Enum Constants

Enum Constant and Description
ONE
ZERO

Method Summary

Methods

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

ZERO

public static final BEDCodec.StartOffset ZERO

ONE

public static final BEDCodec.StartOffset ONE

Method Detail

values

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

Returns:

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

valueOf

public static BEDCodec.StartOffset 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

value

public int value()