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

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

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.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

utilitiesPreferencesKey

public static final UtilitiesPathParameters.UtilitiesPathKey utilitiesPreferencesKey

Folder containing the compomics utilities user preferences file.

ptmFactoryKey

public static final UtilitiesPathParameters.UtilitiesPathKey ptmFactoryKey

Folder containing the PTM user preferences file.

enzymeFactoryKey

public static final UtilitiesPathParameters.UtilitiesPathKey enzymeFactoryKey

File containing the enzymes implemented.

geneMappingKey

public static final UtilitiesPathParameters.UtilitiesPathKey geneMappingKey

Folder containing the gene mapping files.

prideAnnotationKey

public static final UtilitiesPathParameters.UtilitiesPathKey prideAnnotationKey

Folder containing the pride annotation preferences.

identificationParametersKey

public static final UtilitiesPathParameters.UtilitiesPathKey identificationParametersKey

Folder containing the identification parameters.

Method Details

values

public static UtilitiesPathParameters.UtilitiesPathKey[] 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

public static UtilitiesPathParameters.UtilitiesPathKey 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

getId

public String getId()

Description copied from interface: PathKey

Returns the id of the path.

Specified by:

getId in interface PathKey

Returns:

the id of the path

getDescription

public String getDescription()

Description copied from interface: PathKey

Returns the description of the path.

Specified by:

getDescription in interface PathKey

Returns:

the description of the path

getKeyFromId

public static UtilitiesPathParameters.UtilitiesPathKey getKeyFromId(String id)

Returns the key from its id. Null if not found.

Parameters:

id - the id of the key of interest

Returns:

the key of interest