Enum OutputParameters
- All Implemented Interfaces:
Serializable
,Comparable<OutputParameters>
,java.lang.constant.Constable
public enum OutputParameters extends Enum<OutputParameters>
This enum lists the possible output options.
- Author:
- Marc Vaudel, Harald Barsnes
-
Nested Class Summary
-
Enum Constant Summary
-
Field Summary
Fields Modifier and Type Field 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 Description static String
getCommandLineOptions()
Convenience method returning all possibilities in a command line option description format.static int[]
getOutputOptions()
Returns an array of the indexes of the different output options.static OutputParameters
getOutputParameters(int id)
Returns the output option of the given index.static String[]
getOutputParametersNames()
Returns an array of the names of the different options.static OutputParameters
valueOf(String name)
Returns the enum constant of this type with the specified name.static OutputParameters[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
Field Details
-
id
public final int idThe index of the option. -
name
Name of the option. -
description
The description of the option.
-
-
Method Details
-
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
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 nameNullPointerException
- 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
-
getOutputParametersNames
Returns an array of the names of the different options.- Returns:
- an array of the names of the different options
-
getOutputParameters
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
Convenience method returning all possibilities in a command line option description format.- Returns:
- all possibilities in a command line option description format
-