htsjdk.variant.vcf

Enum VCFHeaderVersion

java.lang.Object

java.lang.Enum<VCFHeaderVersion>

htsjdk.variant.vcf.VCFHeaderVersion

All Implemented Interfaces:

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

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

information that identifies each header version

Enum Constant Summary

Enum Constants

Enum Constant and Description
VCF3_2
VCF3_3
VCF4_0
VCF4_1
VCF4_2

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getFormatString()
static VCFHeaderVersion	getHeaderVersion(java.lang.String versionLine)
java.lang.String	getVersionString()
boolean	isAtLeastAsRecentAs(VCFHeaderVersion target) Determines whether this version is at least as recent as a given version
static boolean	isFormatString(java.lang.String format) are we a valid format string for some type
static boolean	isVersionString(java.lang.String version) are we a valid version string of some type
static VCFHeaderVersion	toHeaderVersion(java.lang.String version) get the header version
static VCFHeaderVersion	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static VCFHeaderVersion[]	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

VCF3_2

public static final VCFHeaderVersion VCF3_2

VCF3_3

public static final VCFHeaderVersion VCF3_3

VCF4_0

public static final VCFHeaderVersion VCF4_0

VCF4_1

public static final VCFHeaderVersion VCF4_1

VCF4_2

public static final VCFHeaderVersion VCF4_2

Method Detail

values

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

Returns:

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

valueOf

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

toHeaderVersion

public static VCFHeaderVersion toHeaderVersion(java.lang.String version)

get the header version

Parameters:

version - the version string

Returns:

a VCFHeaderVersion object

isVersionString

public static boolean isVersionString(java.lang.String version)

are we a valid version string of some type

Parameters:

version - the version string

Returns:

true if we're valid of some type, false otherwise

isFormatString

public static boolean isFormatString(java.lang.String format)

are we a valid format string for some type

Parameters:

format - the format string

Returns:

true if we're valid of some type, false otherwise

getHeaderVersion

public static VCFHeaderVersion getHeaderVersion(java.lang.String versionLine)

isAtLeastAsRecentAs

public boolean isAtLeastAsRecentAs(VCFHeaderVersion target)

Determines whether this version is at least as recent as a given version

Parameters:

target - the target version to compare against

Returns:

true if this version is at least as recent as the target version, false otherwise

getVersionString

public java.lang.String getVersionString()

getFormatString

public java.lang.String getFormatString()