Package htsjdk.variant.vcf
Enum VCFHeaderVersion
- java.lang.Object
-
- java.lang.Enum<VCFHeaderVersion>
-
- htsjdk.variant.vcf.VCFHeaderVersion
-
- All Implemented Interfaces:
Serializable
,Comparable<VCFHeaderVersion>
public enum VCFHeaderVersion extends Enum<VCFHeaderVersion>
information that identifies each header version
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getFormatString()
static VCFHeaderVersion
getHeaderVersion(String versionLine)
String
getVersionString()
boolean
isAtLeastAsRecentAs(VCFHeaderVersion target)
Determines whether this version is at least as recent as a given versionstatic boolean
isFormatString(String format)
are we a valid format string for some typestatic boolean
isVersionString(String version)
are we a valid version string of some typestatic VCFHeaderVersion
toHeaderVersion(String version)
get the header versionstatic VCFHeaderVersion
valueOf(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.
-
-
-
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
-
VCF4_3
public static final VCFHeaderVersion VCF4_3
-
-
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(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:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
toHeaderVersion
public static VCFHeaderVersion toHeaderVersion(String version)
get the header version- Parameters:
version
- the version string- Returns:
- a VCFHeaderVersion object
-
isVersionString
public static boolean isVersionString(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(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(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 String getVersionString()
-
getFormatString
public String getFormatString()
-
-