peakml.chemistry
Enum Polarity

java.lang.Object
  extended by java.lang.Enum<Polarity>
      extended by peakml.chemistry.Polarity
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Polarity>

public enum Polarity
extends java.lang.Enum<Polarity>

The polarity setting of the instrument used when collecting the data.


Enum Constant Summary
NEGATIVE
          The MS data was acquired in negative ionisation mode.
NEUTRAL
          The data was acquired without ionisation or has been corrected (can also be used for Spectrum.Type.PDA data).
POSITIVE
          The MS data was acquired in positive ionisation mode.
POSITIVE_NEGATIVE
          The data was acquired in both negative as well as positive ionisation mode.
 
Method Summary
static Polarity valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static Polarity[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

NEGATIVE

public static final Polarity NEGATIVE
The MS data was acquired in negative ionisation mode.


NEUTRAL

public static final Polarity NEUTRAL
The data was acquired without ionisation or has been corrected (can also be used for Spectrum.Type.PDA data).


POSITIVE

public static final Polarity POSITIVE
The MS data was acquired in positive ionisation mode.


POSITIVE_NEGATIVE

public static final Polarity POSITIVE_NEGATIVE
The data was acquired in both negative as well as positive ionisation mode. Used for ChromatographyMS, which can contain spectra with both ionization settings.

Method Detail

values

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

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

valueOf

public static Polarity valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null