Package eu.isas.searchgui.parameters

Enum SearchGUIPathParameters.SearchGUIPathKey

java.lang.Object

java.lang.Enum<SearchGUIPathParameters.SearchGUIPathKey>

eu.isas.searchgui.parameters.SearchGUIPathParameters.SearchGUIPathKey

All Implemented Interfaces:

com.compomics.software.settings.PathKey, Serializable, Comparable<SearchGUIPathParameters.SearchGUIPathKey>, java.lang.constant.Constable

Enclosing class:

SearchGUIPathParameters

public static enum SearchGUIPathParameters.SearchGUIPathKey
extends Enum<SearchGUIPathParameters.SearchGUIPathKey>
implements com.compomics.software.settings.PathKey

Enum of the paths which can be set in SearchGUI.

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
cmsFolder	The folder to use for cms files.
tempDirectory	Directory where SearchGUI temporary files should be stored.
tempSearchEngineDirectory	Folder where search engine temporary files should be stored.

Method Summary

Modifier and Type	Method	Description
String	getDescription()
String	getId()
static SearchGUIPathParameters.SearchGUIPathKey	getKeyFromId(String id)	Returns the key from its id.
static SearchGUIPathParameters.SearchGUIPathKey	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SearchGUIPathParameters.SearchGUIPathKey[]	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

tempDirectory

public static final SearchGUIPathParameters.SearchGUIPathKey tempDirectory

Directory where SearchGUI temporary files should be stored.

tempSearchEngineDirectory

public static final SearchGUIPathParameters.SearchGUIPathKey tempSearchEngineDirectory

Folder where search engine temporary files should be stored.

cmsFolder

public static final SearchGUIPathParameters.SearchGUIPathKey cmsFolder

The folder to use for cms files.

Method Details

values

public static SearchGUIPathParameters.SearchGUIPathKey[] 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 SearchGUIPathParameters.SearchGUIPathKey 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

getKeyFromId

public static SearchGUIPathParameters.SearchGUIPathKey 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

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