Package eu.isas.reporter.preferences

Enum ReporterPathPreferences.ReporterPathKey

java.lang.Object

java.lang.Enum<ReporterPathPreferences.ReporterPathKey>

eu.isas.reporter.preferences.ReporterPathPreferences.ReporterPathKey

All Implemented Interfaces:

com.compomics.software.settings.PathKey, Serializable, Comparable<ReporterPathPreferences.ReporterPathKey>, java.lang.constant.Constable

Enclosing class:

ReporterPathPreferences

public static enum ReporterPathPreferences.ReporterPathKey
extends Enum<ReporterPathPreferences.ReporterPathKey>
implements com.compomics.software.settings.PathKey

Enum of the paths which can be set in Reporter.

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
reporterExports	Folder containing the user custom exports file.

Method Summary

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

reporterExports

public static final ReporterPathPreferences.ReporterPathKey reporterExports

Folder containing the user custom exports file.

Method Details

values

public static ReporterPathPreferences.ReporterPathKey[] 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 ReporterPathPreferences.ReporterPathKey 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 ReporterPathPreferences.ReporterPathKey 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