Unit.Kind

java.lang.Object
- java.lang.Enum<Unit.Kind>
- - org.sbml.jsbml.Unit.Kind

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Unit.Kind>

Enclosing class:

Unit
```
public static enum Unit.Kind
extends java.lang.Enum<Unit.Kind>
```
This enumeration contains an exhaustive list of all available unit kinds within all Levels and Versions of SBML. Note that some of these kinds are not available in some Level/Version combinations, such as AVOGADRO, which has been defined in Level 3 for the first time, or CELSIUS, which has been removed from the specification of SBML in Level 2 Version 4. This enum also provides helpful methods, for instance, to check if two instances of Unit.Kind with different names are still equivalent (#areEquivalent(Kind, Kind)), or to get the formula symbol of the Unit.Kind (getSymbol()).

Author:

Andreas Dräger

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AMPERE` The ampere unit.
`AVOGADRO` This unit is DIMENSIONLESS multiplied with Avogadro's number.
`BECQUEREL` The becquerel unit.
`CANDELA` The candela unit.
`CELSIUS` Deprecated. use `KELVIN` instead (1 Celsius = 1 K + 271.15)
`COULOMB` The coulomb unit.
`DIMENSIONLESS` A pseudo-unit indicating a dimensionless quantity.
`FARAD` The farad unit.
`GRAM` The gram unit.
`GRAY` The gray unit.
`HENRY` The henry unit.
`HERTZ` The hertz unit.
`INVALID` Marker used to indicate an invalid or not yet set unit.
`ITEM` A pseudo-unit representing a single 'thing'.
`JOULE` The joule unit.
`KATAL` The katal unit.
`KELVIN` The kelvin unit.
`KILOGRAM` The kilogram unit.
`LITER` Deprecated. use `LITRE` instead.
`LITRE` The litre unit.
`LUMEN` The lumen unit.
`LUX` The lux unit.
`METER` Deprecated. use `METRE` instead.
`METRE` The metre unit.
`MOLE` The mole unit.
`NEWTON` The newton unit.
`OHM` The ohm unit.
`PASCAL` The pascal unit.
`RADIAN` The radian unit.
`SECOND` The second unit.
`SIEMENS` The siemens unit.
`SIEVERT` The sievert unit.
`STERADIAN` The steradian unit.
`TESLA` The tesla unit.
`VOLT` The volt unit.
`WATT` The watt unit.
`WEBER` The weber unit.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`areEquivalent(Unit.Kind kind1, Unit.Kind kind2)` Tests whether the both given unit kinds are equivalent, i.e., it also considers METRE and METER and LITRE and LITER.
`java.lang.String`	`getName()` Returns the name of this unit kind.
`java.lang.String`	`getSymbol()`
`static java.util.Set<Unit.Kind>`	`getUnitKindsDefinedIn(int level, int version)` Returns a set of `Unit.Kind` objects for the given level/version combination of SBML.
`java.lang.String`	`getUnitOntologyIdentifier()` Creates a unit ontology identifier for this `Unit.Kind` if possible and returns it.
`int`	`getUnitOntologyNumber()` Looks for the corresponding unit ontology resource for this `Unit.Kind`.
`java.lang.String`	`getUnitOntologyResource()` Creates a MIRIAM resource pointing to the entry in the unit ontology corresponding to this `Unit.Kind`.
`boolean`	`isDefinedIn(int level, int version)` Tests whether this kind of unit is defined in the given level and version of SBML.
`static boolean`	`isValidUnitKindString(java.lang.String unitKind, int level, int version)` This method is equivalent to converting the `String` to a `Unit.Kind` and then calling its `isDefinedIn(int, int)` method.
`static Unit.Kind`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static Unit.Kind[]`	`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
  - AMPERE
```
public static final Unit.Kind AMPERE
```
    The ampere unit.
  - AVOGADRO
```
public static final Unit.Kind AVOGADRO
```
    This unit is DIMENSIONLESS multiplied with Avogadro's number.
  - BECQUEREL
```
public static final Unit.Kind BECQUEREL
```
    The becquerel unit.
  - CANDELA
```
public static final Unit.Kind CANDELA
```
    The candela unit.
  - CELSIUS
```
@Deprecated
public static final Unit.Kind CELSIUS
```
    Deprecated. use KELVIN instead (1 Celsius = 1 K + 271.15)
    
    The Celsius unit.
  - COULOMB
```
public static final Unit.Kind COULOMB
```
    The coulomb unit.
  - DIMENSIONLESS
```
public static final Unit.Kind DIMENSIONLESS
```
    A pseudo-unit indicating a dimensionless quantity. (This is in fact defined in the SBML specification.)
  - FARAD
```
public static final Unit.Kind FARAD
```
    The farad unit.
  - GRAM
```
public static final Unit.Kind GRAM
```
    The gram unit.
  - GRAY
```
public static final Unit.Kind GRAY
```
    The gray unit.
  - HENRY
```
public static final Unit.Kind HENRY
```
    The henry unit.
  - HERTZ
```
public static final Unit.Kind HERTZ
```
    The hertz unit.
  - INVALID
```
public static final Unit.Kind INVALID
```
    Marker used to indicate an invalid or not yet set unit.
  - ITEM
```
public static final Unit.Kind ITEM
```
    A pseudo-unit representing a single 'thing'. (This is in fact defined in the SBML specification.)
  - JOULE
```
public static final Unit.Kind JOULE
```
    The joule unit.
  - KATAL
```
public static final Unit.Kind KATAL
```
    The katal unit.
  - KELVIN
```
public static final Unit.Kind KELVIN
```
    The kelvin unit.
  - KILOGRAM
```
public static final Unit.Kind KILOGRAM
```
    The kilogram unit.
  - LITER
```
@Deprecated
public static final Unit.Kind LITER
```
    Deprecated. use LITRE instead.
    
    Alternate spelling of litre.
  - LITRE
```
public static final Unit.Kind LITRE
```
    The litre unit.
  - LUMEN
```
public static final Unit.Kind LUMEN
```
    The lumen unit.
  - LUX
```
public static final Unit.Kind LUX
```
    The lux unit.
  - METER
```
@Deprecated
public static final Unit.Kind METER
```
    Deprecated. use METRE instead.
    
    Alternate spelling of metre.
  - METRE
```
public static final Unit.Kind METRE
```
    The metre unit.
  - MOLE
```
public static final Unit.Kind MOLE
```
    The mole unit.
  - NEWTON
```
public static final Unit.Kind NEWTON
```
    The newton unit.
  - OHM
```
public static final Unit.Kind OHM
```
    The ohm unit.
  - PASCAL
```
public static final Unit.Kind PASCAL
```
    The pascal unit.
  - RADIAN
```
public static final Unit.Kind RADIAN
```
    The radian unit.
  - SECOND
```
public static final Unit.Kind SECOND
```
    The second unit.
  - SIEMENS
```
public static final Unit.Kind SIEMENS
```
    The siemens unit.
  - SIEVERT
```
public static final Unit.Kind SIEVERT
```
    The sievert unit.
  - STERADIAN
```
public static final Unit.Kind STERADIAN
```
    The steradian unit.
  - TESLA
```
public static final Unit.Kind TESLA
```
    The tesla unit.
  - VOLT
```
public static final Unit.Kind VOLT
```
    The volt unit.
  - WATT
```
public static final Unit.Kind WATT
```
    The watt unit.
  - WEBER
```
public static final Unit.Kind WEBER
```
    The weber unit.
- Method Detail
  - values
```
public static Unit.Kind[] 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 (Unit.Kind c : Unit.Kind.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Unit.Kind 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
  - areEquivalent
```
public static boolean areEquivalent(Unit.Kind kind1,
                                    Unit.Kind kind2)
```
    Tests whether the both given unit kinds are equivalent, i.e., it also considers METRE and METER and LITRE and LITER.
    
    Parameters:
    
    kind1 -
    
    kind2 -
    
    Returns:
  - getUnitKindsDefinedIn
```
public static java.util.Set<Unit.Kind> getUnitKindsDefinedIn(int level,
                                                             int version)
```
    Returns a set of Unit.Kind objects for the given level/version combination of SBML.
    
    Parameters:
    
    level -
    
    version -
    
    Returns:
    
    A Set that only contains Unit.Kinds for the given level/version combination.
  - isValidUnitKindString
```
public static boolean isValidUnitKindString(java.lang.String unitKind,
                                            int level,
                                            int version)
```
    This method is equivalent to converting the String to a Unit.Kind and then calling its isDefinedIn(int, int) method. Only entirely upper or entirely lower case Strings are valid attributes here. This method tests whether a given string corresponds to a predefined Unit.Kind enumeration value. To check whether a given String represents some predefined UnitDefinition, please use the method Unit.isPredefined(String, int).
    
    Parameters:
    
    unitKind - the unit string.
    
    level - the SBML level.
    
    version - the SBML version.
    
    Returns:
    
    true if the given string is valid for the particular SBML level and version, false otherwise.
    
    See Also:
    
    Unit.isPredefined(String, int)
  - getName
```
public java.lang.String getName()
```
    Returns the name of this unit kind.
    
    Returns:
  - getSymbol
```
public java.lang.String getSymbol()
```
    Returns:
    
    the formula symbol of this unit kind in uni-code notation.
  - getUnitOntologyIdentifier
```
public java.lang.String getUnitOntologyIdentifier()
```
    Creates a unit ontology identifier for this Unit.Kind if possible and returns it. See the Unit Ontology for more information.
    
    Returns:
    
    the unit ontology identifier for this Unit.Kind or null if this Unit.Kind has no corresponding type in the unit ontology.
    
    See Also:
    
    getUnitOntologyNumber()
  - getUnitOntologyNumber
```
public int getUnitOntologyNumber()
```
    Looks for the corresponding unit ontology resource for this Unit.Kind. Please visit http://bioportal.bioontology.org/visualize/44519/?conceptid=UO%3A0000003 and http://www.ebi.ac.uk/miriam/main/datatypes/MIR:00000136 for more details.
    
    Returns:
    
    the unit ontology number of this Unit.Kind or -1 if no entry exists for this Unit.Kind in the unit ontology.
  - getUnitOntologyResource
```
public java.lang.String getUnitOntologyResource()
```
    Creates a MIRIAM resource pointing to the entry in the unit ontology corresponding to this Unit.Kind. If such an entry exists, this method will return the String http://identifiers.org/unit/UO: plus the number of the resource filled to a seven-digit number by inserting leading zeros.
    
    Returns:
    
    null if no corresponding entry exists in the unit ontology, otherwise a MIRIAM resource pointing to it.
  - isDefinedIn
```
public boolean isDefinedIn(int level,
                           int version)
```
    Tests whether this kind of unit is defined in the given level and version of SBML.
    
    Parameters:
    
    level -
    
    version -
    
    Returns:

Enum Unit.Kind

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

AMPERE

AVOGADRO

BECQUEREL

CANDELA

CELSIUS

COULOMB

DIMENSIONLESS

FARAD

GRAM

GRAY

HENRY

HERTZ

INVALID

ITEM

JOULE

KATAL

KELVIN

KILOGRAM

LITER

LITRE

LUMEN

LUX

METER

METRE

MOLE

NEWTON

OHM

PASCAL

RADIAN

SECOND

SIEMENS

SIEVERT

STERADIAN

TESLA

VOLT

WATT

WEBER

Method Detail

values

valueOf

areEquivalent

getUnitKindsDefinedIn

isValidUnitKindString

getName

getSymbol

getUnitOntologyIdentifier

getUnitOntologyNumber

getUnitOntologyResource

isDefinedIn