Enum VcfHeaderInfo.VcfInfoNumber

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<VcfHeaderInfo.VcfInfoNumber>
    Enclosing class:
    VcfHeaderInfo

    public static enum VcfHeaderInfo.VcfInfoNumber
    extends java.lang.Enum<VcfHeaderInfo.VcfInfoNumber>
    Number of values in an INFO field. Reference http://samtools.github.io/hts-specs/VCFv4.2.pdf Number of items in an INFO field. The Number entry is an Integer that describes the number of values that can be included with the INFO field. For example, if the INFO field contains a single number, then this value should be 1; if the INFO field describes a pair of numbers, then this value should be 2 and so on. There are also certain special characters used to define special cases: - If the field has one value per alternate allele then this value should be `A'. - If the field has one value for each possible allele (including the reference), then this value should be `R'. - If the field has one value for each possible genotype (more relevant to the FORMAT tags) then this value should be `G'. - If the number of possible values varies, is unknown, or is unbounded, then this value should be `.'. The `Flag' type indicates that the INFO field does not contain a Value entry, and hence the Number should be 0 in this case.
    • Method Detail

      • values

        public static VcfHeaderInfo.VcfInfoNumber[] 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 (VcfHeaderInfo.VcfInfoNumber c : VcfHeaderInfo.VcfInfoNumber.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static VcfHeaderInfo.VcfInfoNumber 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