eu.isas.peptideshaker.preferences

Enum PeptideShakerPathParameters.PeptideShakerPathKey

java.lang.Object

java.lang.Enum<PeptideShakerPathParameters.PeptideShakerPathKey>

eu.isas.peptideshaker.preferences.PeptideShakerPathParameters.PeptideShakerPathKey

All Implemented Interfaces:

com.compomics.software.settings.PathKey, Serializable, Comparable<PeptideShakerPathParameters.PeptideShakerPathKey>

Enclosing class:

PeptideShakerPathParameters

public static enum PeptideShakerPathParameters.PeptideShakerPathKey
extends Enum<PeptideShakerPathParameters.PeptideShakerPathKey>
implements com.compomics.software.settings.PathKey

Enum of the paths which can be set in PeptideShaker.

Enum Constant Summary

Enum Constants

Enum Constant and Description
cmsFolder The folder to use for cms files.
matchesDirectory Directory where identification matches are temporarily saved to reduce the memory footprint.
peptideShakerExports Folder containing the user custom exports file.
peptideShakerPreferences Folder containing the PeptideShaker user preferences file.
unzipFolder The folder to use when unzipping files.

Method Summary

Modifier and Type	Method and Description
String	getDescription()
String	getId()
static PeptideShakerPathParameters.PeptideShakerPathKey	getKeyFromId(String id) Returns the key from its id.
static PeptideShakerPathParameters.PeptideShakerPathKey	valueOf(String name) Returns the enum constant of this type with the specified name.
static PeptideShakerPathParameters.PeptideShakerPathKey[]	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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

matchesDirectory

public static final PeptideShakerPathParameters.PeptideShakerPathKey matchesDirectory

Directory where identification matches are temporarily saved to reduce the memory footprint.

peptideShakerPreferences

public static final PeptideShakerPathParameters.PeptideShakerPathKey peptideShakerPreferences

Folder containing the PeptideShaker user preferences file.

peptideShakerExports

public static final PeptideShakerPathParameters.PeptideShakerPathKey peptideShakerExports

Folder containing the user custom exports file.

unzipFolder

public static final PeptideShakerPathParameters.PeptideShakerPathKey unzipFolder

The folder to use when unzipping files.

cmsFolder

public static final PeptideShakerPathParameters.PeptideShakerPathKey cmsFolder

The folder to use for cms files.

Method Detail

values

public static PeptideShakerPathParameters.PeptideShakerPathKey[] 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 (PeptideShakerPathParameters.PeptideShakerPathKey c : PeptideShakerPathParameters.PeptideShakerPathKey.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PeptideShakerPathParameters.PeptideShakerPathKey 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()

Specified by:

getId in interface com.compomics.software.settings.PathKey

getDescription

public String getDescription()

Specified by:

getDescription in interface com.compomics.software.settings.PathKey

getKeyFromId

public static PeptideShakerPathParameters.PeptideShakerPathKey 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