htsjdk.variant.vcf

Enum VCFHeaderLineType

java.lang.Object

java.lang.Enum<VCFHeaderLineType>

htsjdk.variant.vcf.VCFHeaderLineType

All Implemented Interfaces:

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

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

the type encodings we use for fields in VCF header lines

Enum Constant Summary

Enum Constants

Enum Constant and Description
Character
Flag
Float
Integer
String

Method Summary

Methods

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

Integer

public static final VCFHeaderLineType Integer

Float

public static final VCFHeaderLineType Float

String

public static final VCFHeaderLineType String

Character

public static final VCFHeaderLineType Character

Flag

public static final VCFHeaderLineType Flag

Method Detail

values

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

Returns:

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

valueOf

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