com.compomics.util.preferences

Enum SearchGuiOutputOption

java.lang.Object

java.lang.Enum<SearchGuiOutputOption>

com.compomics.util.preferences.SearchGuiOutputOption

All Implemented Interfaces:

Serializable, Comparable<SearchGuiOutputOption>

public enum SearchGuiOutputOption
extends Enum<SearchGuiOutputOption>

This enum lists the possible output options.

Author:

Marc Vaudel, Harald Barsnes

Enum Constant Summary

Enum Constants

Enum Constant and Description
algorithm Groups files per identification algorithm.
grouped Groups all files in a single compressed zip folder.
no_zip No file grouping.
run Groups files per run (i.e.

Field Summary

Fields

Modifier and Type	Field and Description
String	description The description of the option.
int	id The index of the option.
String	name Name of the option.

Method Summary

Modifier and Type	Method and Description
static String	getCommandLineOptions() Convenience method returning all possibilities in a command line option description format.
static SearchGuiOutputOption	getOutputOption(int id) Returns the output option of the given index.
static int[]	getOutputOptions() Returns an array of the indexes of the different output options.
static String[]	getOutputOptionsNames() Returns an array of the names of the different options.
static SearchGuiOutputOption	valueOf(String name) Returns the enum constant of this type with the specified name.
static SearchGuiOutputOption[]	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

grouped

public static final SearchGuiOutputOption grouped

Groups all files in a single compressed zip folder.

run

public static final SearchGuiOutputOption run

Groups files per run (i.e. spectrum file).

algorithm

public static final SearchGuiOutputOption algorithm

Groups files per identification algorithm.

no_zip

public static final SearchGuiOutputOption no_zip

No file grouping.

Field Detail

id

public final int id

The index of the option.

name

public final String name

Name of the option.

description

public final String description

The description of the option.

Method Detail

values

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

Returns:

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

valueOf

public static SearchGuiOutputOption 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

getOutputOptions

public static int[] getOutputOptions()

Returns an array of the indexes of the different output options.

Returns:

an array of the indexes of the different output options

getOutputOptionsNames

public static String[] getOutputOptionsNames()

Returns an array of the names of the different options.

Returns:

an array of the names of the different options

getOutputOption

public static SearchGuiOutputOption getOutputOption(int id)

Returns the output option of the given index.

Parameters:

id - the index of the output option of interest

Returns:

the output option of interest

getCommandLineOptions

public static String getCommandLineOptions()

Convenience method returning all possibilities in a command line option description format.

Returns:

all possibilities in a command line option description format