Enum MzIdentMLVersion
- All Implemented Interfaces:
Serializable
,Comparable<MzIdentMLVersion>
,java.lang.constant.Constable
public enum MzIdentMLVersion extends Enum<MzIdentMLVersion>
Enum of the versions of the mzIdentML format supported.
- Author:
- Marc Vaudel
-
Nested Class Summary
-
Enum Constant Summary
-
Field Summary
Fields Modifier and Type Field Description String
description
The description of the option.String
name
The name of the option. -
Method Summary
Modifier and Type Method Description static String
getCommandLineOptions()
Returns a string describing the different options.static MzIdentMLVersion
getMzIdentMLVersion(int index)
Returns the mzIdentML format corresponding to the given index.static MzIdentMLVersion
valueOf(String name)
Returns the enum constant of this type with the specified name.static MzIdentMLVersion[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
Field Details
-
name
The name of the option. -
description
The description of the option.
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
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
-
getMzIdentMLVersion
Returns the mzIdentML format corresponding to the given index.- Parameters:
index
- the index- Returns:
- the mzIdentML format corresponding to the given index
-
getCommandLineOptions
Returns a string describing the different options.- Returns:
- a string describing the different options
-