Package com.compomics.software.settings
Enum UtilitiesPathParameters.UtilitiesPathKey
java.lang.Object
java.lang.Enum<UtilitiesPathParameters.UtilitiesPathKey>
com.compomics.software.settings.UtilitiesPathParameters.UtilitiesPathKey
- All Implemented Interfaces:
PathKey
,Serializable
,Comparable<UtilitiesPathParameters.UtilitiesPathKey>
,java.lang.constant.Constable
- Enclosing class:
- UtilitiesPathParameters
public static enum UtilitiesPathParameters.UtilitiesPathKey extends Enum<UtilitiesPathParameters.UtilitiesPathKey> implements PathKey
Enum of the paths which can be set in utilities.
-
Nested Class Summary
-
Enum Constant Summary
Enum Constants Enum Constant Description enzymeFactoryKey
File containing the enzymes implemented.geneMappingKey
Folder containing the gene mapping files.identificationParametersKey
Folder containing the identification parameters.prideAnnotationKey
Folder containing the pride annotation preferences.ptmFactoryKey
Folder containing the PTM user preferences file.utilitiesPreferencesKey
Folder containing the compomics utilities user preferences file. -
Method Summary
Modifier and Type Method Description String
getDescription()
Returns the description of the path.String
getId()
Returns the id of the path.static UtilitiesPathParameters.UtilitiesPathKey
getKeyFromId(String id)
Returns the key from its id.static UtilitiesPathParameters.UtilitiesPathKey
valueOf(String name)
Returns the enum constant of this type with the specified name.static UtilitiesPathParameters.UtilitiesPathKey[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
utilitiesPreferencesKey
Folder containing the compomics utilities user preferences file. -
ptmFactoryKey
Folder containing the PTM user preferences file. -
enzymeFactoryKey
File containing the enzymes implemented. -
geneMappingKey
Folder containing the gene mapping files. -
prideAnnotationKey
Folder containing the pride annotation preferences. -
identificationParametersKey
Folder containing the identification parameters.
-
-
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
-
getId
Description copied from interface:PathKey
Returns the id of the path. -
getDescription
Description copied from interface:PathKey
Returns the description of the path.- Specified by:
getDescription
in interfacePathKey
- Returns:
- the description of the path
-
getKeyFromId
Returns the key from its id. Null if not found.- Parameters:
id
- the id of the key of interest- Returns:
- the key of interest
-