UnitsLength (Bio-Formats API)

java.lang.Object
- java.lang.Enum<UnitsLength>
- - ome.xml.model.enums.UnitsLength

All Implemented Interfaces:: Serializable, Comparable<UnitsLength>, Enumeration

public enum UnitsLength
extends Enum<UnitsLength>
implements Enumeration

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ANGSTROM` ångström SI-derived unit.
`ASTRONOMICALUNIT` astronomical unit SI-derived unit.
`ATTOMETER` attometer SI unit.
`CENTIMETER` centimeter SI unit.
`DECAMETER` decameter SI unit.
`DECIMETER` decimeter SI unit.
`EXAMETER` exameter SI unit.
`FEMTOMETER` femtometer SI unit.
`FOOT` foot Imperial unit.
`GIGAMETER` gigameter SI unit.
`HECTOMETER` hectometer SI unit.
`INCH` inch Imperial unit.
`KILOMETER` kilometer SI unit.
`LIGHTYEAR` light year.
`LINE` line Imperial unit (1/12 inch).
`MEGAMETER` megameter SI unit.
`METER` meter SI unit.
`MICROMETER` micrometer SI unit.
`MILE` terrestrial mile Imperial unit.
`MILLIMETER` millimeter SI unit.
`NANOMETER` nanometer SI unit.
`PARSEC` parsec.
`PETAMETER` petameter SI unit.
`PICOMETER` picometer SI unit.
`PIXEL` pixel abstract unit.
`POINT` typography point Imperial-derived unit (1/72 inch).
`REFERENCEFRAME` reference frame abstract unit.
`TERAMETER` terameter SI unit.
`THOU` thou Imperial unit (or mil, 1/1000 inch).
`YARD` yard Imperial unit.
`YOCTOMETER` yoctometer SI unit.
`YOTTAMETER` yottameter SI unit.
`ZEPTOMETER` zeptometer SI unit.
`ZETTAMETER` zettameter SI unit.

Field Summary

Fields
Modifier and Type Field and Description

private String value

Fields
Modifier and Type	Field and Description
`private String`	`value`

Method Summary

Methods
Modifier and Type	Method and Description
`static <T extends Number> Length`	`create(T newValue, UnitsLength newUnit)`
`static <T extends PrimitiveNumber> Length`	`create(T newValue, UnitsLength newUnit)`
`static UnitsLength`	`fromString(String value)`
`String`	`getValue()`
`String`	`toString()`
`static UnitsLength`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static UnitsLength[]`	`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, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - YOTTAMETER
```
public static final UnitsLength YOTTAMETER
```
    yottameter SI unit.
  - ZETTAMETER
```
public static final UnitsLength ZETTAMETER
```
    zettameter SI unit.
  - EXAMETER
```
public static final UnitsLength EXAMETER
```
    exameter SI unit.
  - PETAMETER
```
public static final UnitsLength PETAMETER
```
    petameter SI unit.
  - TERAMETER
```
public static final UnitsLength TERAMETER
```
    terameter SI unit.
  - GIGAMETER
```
public static final UnitsLength GIGAMETER
```
    gigameter SI unit.
  - MEGAMETER
```
public static final UnitsLength MEGAMETER
```
    megameter SI unit.
  - KILOMETER
```
public static final UnitsLength KILOMETER
```
    kilometer SI unit.
  - HECTOMETER
```
public static final UnitsLength HECTOMETER
```
    hectometer SI unit.
  - DECAMETER
```
public static final UnitsLength DECAMETER
```
    decameter SI unit.
  - METER
```
public static final UnitsLength METER
```
    meter SI unit.
  - DECIMETER
```
public static final UnitsLength DECIMETER
```
    decimeter SI unit.
  - CENTIMETER
```
public static final UnitsLength CENTIMETER
```
    centimeter SI unit.
  - MILLIMETER
```
public static final UnitsLength MILLIMETER
```
    millimeter SI unit.
  - MICROMETER
```
public static final UnitsLength MICROMETER
```
    micrometer SI unit.
  - NANOMETER
```
public static final UnitsLength NANOMETER
```
    nanometer SI unit.
  - PICOMETER
```
public static final UnitsLength PICOMETER
```
    picometer SI unit.
  - FEMTOMETER
```
public static final UnitsLength FEMTOMETER
```
    femtometer SI unit.
  - ATTOMETER
```
public static final UnitsLength ATTOMETER
```
    attometer SI unit.
  - ZEPTOMETER
```
public static final UnitsLength ZEPTOMETER
```
    zeptometer SI unit.
  - YOCTOMETER
```
public static final UnitsLength YOCTOMETER
```
    yoctometer SI unit.
  - ANGSTROM
```
public static final UnitsLength ANGSTROM
```
    ångström SI-derived unit.
  - THOU
```
public static final UnitsLength THOU
```
    thou Imperial unit (or mil, 1/1000 inch).
  - LINE
```
public static final UnitsLength LINE
```
    line Imperial unit (1/12 inch).
  - INCH
```
public static final UnitsLength INCH
```
    inch Imperial unit.
  - FOOT
```
public static final UnitsLength FOOT
```
    foot Imperial unit.
  - YARD
```
public static final UnitsLength YARD
```
    yard Imperial unit.
  - MILE
```
public static final UnitsLength MILE
```
    terrestrial mile Imperial unit.
  - ASTRONOMICALUNIT
```
public static final UnitsLength ASTRONOMICALUNIT
```
    astronomical unit SI-derived unit. The official term is ua as the SI standard assigned AU to absorbance unit.
  - LIGHTYEAR
```
public static final UnitsLength LIGHTYEAR
```
    light year.
  - PARSEC
```
public static final UnitsLength PARSEC
```
    parsec.
  - POINT
```
public static final UnitsLength POINT
```
    typography point Imperial-derived unit (1/72 inch). Use of this unit should be limited to font sizes.
  - PIXEL
```
public static final UnitsLength PIXEL
```
    pixel abstract unit. This is not convertible to any other length unit without a calibrated scaling factor. Its use should should be limited to ROI objects, and converted to an appropriate length units using the PhysicalSize units of the Image the ROI is attached to.
  - REFERENCEFRAME
```
public static final UnitsLength REFERENCEFRAME
```
    reference frame abstract unit. This is not convertible to any other length unit without a scaling factor. Its use should be limited to uncalibrated stage positions, and converted to an appropriate length unit using a calibrated scaling factor.
- Field Detail
  - value
```
private final String value
```
- Method Detail
  - values
```
public static UnitsLength[] 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 (UnitsLength c : UnitsLength.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static UnitsLength 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
  - fromString
```
public static UnitsLength fromString(String value)
                              throws EnumerationException
```
    Throws:
    
    EnumerationException
  - getValue
```
public String getValue()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Enum<UnitsLength>
  - create
```
public static <T extends PrimitiveNumber> Length create(T newValue,
                                        UnitsLength newUnit)
```
  - create
```
public static <T extends Number> Length create(T newValue,
                               UnitsLength newUnit)
```

Enum UnitsLength

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

YOTTAMETER

ZETTAMETER

EXAMETER

PETAMETER

TERAMETER

GIGAMETER

MEGAMETER

KILOMETER

HECTOMETER

DECAMETER

METER

DECIMETER

CENTIMETER

MILLIMETER

MICROMETER

NANOMETER

PICOMETER

FEMTOMETER

ATTOMETER

ZEPTOMETER

YOCTOMETER

ANGSTROM

THOU

LINE

INCH

FOOT

YARD

MILE

ASTRONOMICALUNIT

LIGHTYEAR

PARSEC

POINT

PIXEL

REFERENCEFRAME

Field Detail

value

Method Detail

values

valueOf

fromString

getValue

toString

create

create