Enum Sex

    • Enum Constant Detail

      • Male

        public static final Sex Male
      • Female

        public static final Sex Female
      • Unknown

        public static final Sex Unknown
      • NotReported

        public static final Sex NotReported
    • Method Detail

      • values

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

        public static Sex 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 name
        NullPointerException - if the argument is null
      • toCode

        public int toCode()
        Returns the code used to encode this sex in a ped/fam file.
      • fromCode

        public static Sex fromCode​(int code)
        Decodes the Sex from a numeric code. Note that any value other than 1 or 2 will return Unknown.
      • toSymbol

        public String toSymbol()
        Returns the single-character symbol used to encode sex in a VCF file
      • fromString

        public static Sex fromString​(String sexString)
        Decodes the Sex from a String. This can be the full string or a single-character symbol representation