Package eu.isas.reporter.quantificationdetails

Enum ProteinRatioType

java.lang.Object

java.lang.Enum<ProteinRatioType>

eu.isas.reporter.quantificationdetails.ProteinRatioType

All Implemented Interfaces:

Serializable, Comparable<ProteinRatioType>, java.lang.constant.Constable

public enum ProteinRatioType
extends Enum<ProteinRatioType>

Enum for the protein ratio types.

Author:

Marc Vaudel

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
all
shared
unique

Field Summary

Fields

Modifier and Type	Field	Description
final String	description	Description of the ratio type.
final int	index	Index of the ratio type.
final String	name	Name of the ratio type.

Method Summary

Modifier and Type	Method	Description
static ProteinRatioType	getProteinRatioType(int index)	Returns the ratio type corresponding to the given index.
static String[]	names()	Returns an array of names of the different options.
static ProteinRatioType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ProteinRatioType[]	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

all

public static final ProteinRatioType all

unique

public static final ProteinRatioType unique

shared

public static final ProteinRatioType shared

Field Details

index

public final int index

Index of the ratio type.

name

public final String name

Name of the ratio type.

description

public final String description

Description of the ratio type.

Method Details

values

public static ProteinRatioType[] 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 ProteinRatioType 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

names

public static String[] names()

Returns an array of names of the different options.

Returns:

an array of names of the different options

getProteinRatioType

public static ProteinRatioType getProteinRatioType(int index)

Returns the ratio type corresponding to the given index.

Parameters:

index - the index

Returns:

the corresponding ratio type.