Package picard.pedigree
Enum Class Sex
- All Implemented Interfaces:
Serializable
,Comparable<Sex>
,Constable
Represents the sex of an individual.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum Constants -
Method Summary
Modifier and TypeMethodDescriptionstatic Sex
fromCode
(int code) Decodes the Sex from a numeric code.static Sex
fromString
(String sexString) Decodes the Sex from a String.int
toCode()
Returns the code used to encode this sex in a ped/fam file.toSymbol()
Returns the single-character symbol used to encode sex in a VCF filestatic Sex
Returns the enum constant of this class with the specified name.static Sex[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
Male
-
Female
-
Unknown
-
NotReported
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
toCode
public int toCode()Returns the code used to encode this sex in a ped/fam file. -
fromCode
Decodes the Sex from a numeric code. Note that any value other than 1 or 2 will return Unknown. -
toSymbol
Returns the single-character symbol used to encode sex in a VCF file -
fromString
Decodes the Sex from a String. This can be the full string or a single-character symbol representation
-