MzidCLIParams (PeptideShaker 2.2.2 API)

java.lang.Object
- java.lang.Enum<MzidCLIParams>
- - eu.isas.peptideshaker.cmd.MzidCLIParams

All Implemented Interfaces:

Serializable, Comparable<MzidCLIParams>
```
public enum MzidCLIParams
extends Enum<MzidCLIParams>
```
Enum class specifying the Command Line Parameters for mzid export.

Author:

Marc Vaudel, Harald Barsnes

Enum Constant Summary

Enum Constants
Enum Constant and Description
`CONTACT_ADDRESS`
`CONTACT_EMAIL`
`CONTACT_FIRST_NAME`
`CONTACT_LAST_NAME`
`CONTACT_URL`
`GZIP`
`INCLUDE_PROTEIN_SEQUENCES`
`ORGANIZATION_ADDRESS`
`ORGANIZATION_EMAIL`
`ORGANIZATION_NAME`
`ORGANIZATION_URL`
`OUTPUT_FILE`
`PSDB_FILE`
`VERSION`

Field Summary

Fields
Modifier and Type	Field and Description
`String`	`description` Explanation for the CLI parameter.
`boolean`	`hasArgument` Indicates whether user input is expected.
`String`	`id` Short Id for the CLI parameter.
`boolean`	`mandatory` Boolean indicating whether the parameter is mandatory.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`createOptionsCLI(org.apache.commons.cli.Options aOptions)` Creates the options for the command line interface based on the possible values.
`static String`	`getOptionsAsString()` Returns the options as a string.
`static MzidCLIParams`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static MzidCLIParams[]`	`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
  - PSDB_FILE
```
public static final MzidCLIParams PSDB_FILE
```
  - CONTACT_FIRST_NAME
```
public static final MzidCLIParams CONTACT_FIRST_NAME
```
  - CONTACT_LAST_NAME
```
public static final MzidCLIParams CONTACT_LAST_NAME
```
  - CONTACT_EMAIL
```
public static final MzidCLIParams CONTACT_EMAIL
```
  - CONTACT_ADDRESS
```
public static final MzidCLIParams CONTACT_ADDRESS
```
  - CONTACT_URL
```
public static final MzidCLIParams CONTACT_URL
```
  - ORGANIZATION_NAME
```
public static final MzidCLIParams ORGANIZATION_NAME
```
  - ORGANIZATION_EMAIL
```
public static final MzidCLIParams ORGANIZATION_EMAIL
```
  - ORGANIZATION_ADDRESS
```
public static final MzidCLIParams ORGANIZATION_ADDRESS
```
  - ORGANIZATION_URL
```
public static final MzidCLIParams ORGANIZATION_URL
```
  - INCLUDE_PROTEIN_SEQUENCES
```
public static final MzidCLIParams INCLUDE_PROTEIN_SEQUENCES
```
  - VERSION
```
public static final MzidCLIParams VERSION
```
  - OUTPUT_FILE
```
public static final MzidCLIParams OUTPUT_FILE
```
  - GZIP
```
public static final MzidCLIParams GZIP
```
- Field Detail
  - id
```
public final String id
```
    Short Id for the CLI parameter.
  - description
```
public final String description
```
    Explanation for the CLI parameter.
  - mandatory
```
public final boolean mandatory
```
    Boolean indicating whether the parameter is mandatory.
  - hasArgument
```
public final boolean hasArgument
```
    Indicates whether user input is expected.
- Method Detail
  - values
```
public static MzidCLIParams[] 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 (MzidCLIParams c : MzidCLIParams.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static MzidCLIParams 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
  - createOptionsCLI
```
public static void createOptionsCLI(org.apache.commons.cli.Options aOptions)
```
    Creates the options for the command line interface based on the possible values.
    
    Parameters:
    
    aOptions - the options object where the options will be added
  - getOptionsAsString
```
public static String getOptionsAsString()
```
    Returns the options as a string.
    
    Returns:
    
    the options as a string

Enum MzidCLIParams

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

PSDB_FILE

CONTACT_FIRST_NAME

CONTACT_LAST_NAME

CONTACT_EMAIL

CONTACT_ADDRESS

CONTACT_URL

ORGANIZATION_NAME

ORGANIZATION_EMAIL

ORGANIZATION_ADDRESS

ORGANIZATION_URL

INCLUDE_PROTEIN_SEQUENCES

VERSION

OUTPUT_FILE

GZIP

Field Detail

id

description

mandatory

hasArgument

Method Detail

values

valueOf

createOptionsCLI

getOptionsAsString