eu.isas.peptideshaker.followup

Enum InclusionListExport.ExportFormat

java.lang.Object

java.lang.Enum<InclusionListExport.ExportFormat>

eu.isas.peptideshaker.followup.InclusionListExport.ExportFormat

All Implemented Interfaces:

Serializable, Comparable<InclusionListExport.ExportFormat>

Enclosing class:

InclusionListExport

public static enum InclusionListExport.ExportFormat
extends Enum<InclusionListExport.ExportFormat>

Enum of the different types of export implemented.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABI ABI format.
Bruker Bruker format.
MassLynx MassLynx format.
Thermo Thermo format.

Field Summary

Fields

Modifier and Type	Field and Description
String	description Description of the export.
String	extension The extension of the file.
int	index Index for the export type.

Method Summary

Modifier and Type	Method and Description
static String	getCommandLineOptions() Returns a description of the command line arguments.
static String[]	getPossibilities() Returns all possibilities descriptions in an array of string.
static InclusionListExport.ExportFormat	getTypeFromIndex(int index) Returns the export type corresponding to a given index.
static InclusionListExport.ExportFormat	valueOf(String name) Returns the enum constant of this type with the specified name.
static InclusionListExport.ExportFormat[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
static File	verifyFileExtension(File destinationFile, InclusionListExport.ExportFormat exportFormat) Verifies that the file extension is chosen according to the manufacturers specification and adds the extension if missing.

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

Thermo

public static final InclusionListExport.ExportFormat Thermo

Thermo format.

ABI

public static final InclusionListExport.ExportFormat ABI

ABI format.

Bruker

public static final InclusionListExport.ExportFormat Bruker

Bruker format.

MassLynx

public static final InclusionListExport.ExportFormat MassLynx

MassLynx format.

Field Detail

index

public int index

Index for the export type.

description

public String description

Description of the export.

extension

public String extension

The extension of the file.

Method Detail

values

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

Returns:

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

valueOf

public static InclusionListExport.ExportFormat 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

getTypeFromIndex

public static InclusionListExport.ExportFormat getTypeFromIndex(int index)

Returns the export type corresponding to a given index.

Parameters:

index - the index of interest

Returns:

the export type corresponding to a given index

getPossibilities

public static String[] getPossibilities()

Returns all possibilities descriptions in an array of string. Tip: the position in the array corresponds to the type index.

Returns:

all possibilities descriptions in an array of string

getCommandLineOptions

public static String getCommandLineOptions()

Returns a description of the command line arguments.

Returns:

a description of the command line arguments

verifyFileExtension

public static File verifyFileExtension(File destinationFile,
                                       InclusionListExport.ExportFormat exportFormat)

Verifies that the file extension is chosen according to the manufacturers specification and adds the extension if missing.

Parameters:

destinationFile - the destination file

exportFormat - the export format

Returns:

returns a file with updated extension