Package com.compomics.util.experiment.units

Enum StandardUnit

java.lang.Object

java.lang.Enum<StandardUnit>

com.compomics.util.experiment.units.StandardUnit

All Implemented Interfaces:

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

public enum StandardUnit
extends Enum<StandardUnit>

The standard units implemented.

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
mol
percentage
ppm

Field Summary

Fields

Modifier and Type	Field	Description
final String	ABBREVIATION	The abbreviated name of the unit.
final String	FULL_NAME	The full name of the unit.

Method Summary

Modifier and Type	Method	Description
static StandardUnit	getStandardUnit(String fullName)	Returns the standard unit having the given full name.
static StandardUnit	valueOf(String name)	Returns the enum constant of this type with the specified name.
static StandardUnit[]	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

mol

public static final StandardUnit mol

percentage

public static final StandardUnit percentage

ppm

public static final StandardUnit ppm

Field Details

FULL_NAME

public final String FULL_NAME

The full name of the unit.

ABBREVIATION

public final String ABBREVIATION

The abbreviated name of the unit.

Method Details

values

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

getStandardUnit

public static StandardUnit getStandardUnit(String fullName)

Returns the standard unit having the given full name.

Parameters:

fullName - the full name of interest

Returns:

the standard unit having the given full name