Package htsjdk.variant.vcf

Enum Class VCFHeaderVersion

java.lang.Object
java.lang.Enum<VCFHeaderVersion>
htsjdk.variant.vcf.VCFHeaderVersion
All Implemented Interfaces:
Serializable, Comparable<VCFHeaderVersion>, Constable
public enum VCFHeaderVersion extends Enum<VCFHeaderVersion>
information that identifies each header version

  • Enum Constant Details

  • Method Details

    • values

      public static VCFHeaderVersion[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static VCFHeaderVersion valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - 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()