DistanceUnit (Units of Measurement Enum Implementation 2.1 API)

java.lang.Object
- java.lang.Enum<DistanceUnit>
- - tech.uom.impl.enums.unit.DistanceUnit

All Implemented Interfaces:

Serializable, Comparable<DistanceUnit>, javax.measure.Unit<javax.measure.quantity.Length>, tech.uom.lib.common.function.DescriptionSupplier, tech.uom.lib.common.function.DoubleFactorSupplier, tech.uom.lib.common.util.DescriptiveEnum<DistanceUnit>
```
public enum DistanceUnit
extends Enum<DistanceUnit>
implements javax.measure.Unit<javax.measure.quantity.Length>, tech.uom.lib.common.function.DoubleFactorSupplier, tech.uom.lib.common.util.DescriptiveEnum<DistanceUnit>
```
Version:

1.5, $Date: 2019-02-04 $

Author:

Werner Keil

Enum Constant Summary

Enum Constants
Enum Constant and Description

KILOMETRE

METRE

Enum Constants
Enum Constant and Description
`KILOMETRE`
`METRE`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`javax.measure.Unit<javax.measure.quantity.Length>`	`alternate(String s)`
`<T extends javax.measure.Quantity<T>> javax.measure.Unit<T>`	`asType(Class<T> tClass)`
`javax.measure.Unit<javax.measure.quantity.Length>`	`divide(double v)`
`javax.measure.Unit<javax.measure.quantity.Length>`	`divide(Number divisor)`
`javax.measure.Unit<?>`	`divide(javax.measure.Unit<?> unit)`
`tech.uom.lib.common.util.DescriptiveEnum<DistanceUnit>[]`	`dValues()`
`Map<? extends javax.measure.Unit<javax.measure.quantity.Length>,Integer>`	`getBaseUnits()`
`static DistanceUnit`	`getBySymbol(String symbol)`
`javax.measure.UnitConverter`	`getConverterTo(javax.measure.Unit<javax.measure.quantity.Length> that)`
`javax.measure.UnitConverter`	`getConverterToAny(javax.measure.Unit<?> that)`
`String`	`getDescription()`
`javax.measure.Dimension`	`getDimension()`
`double`	`getFactor()`
`String`	`getName()`
`String`	`getSymbol()`
`javax.measure.Unit<javax.measure.quantity.Length>`	`getSystemUnit()`
`javax.measure.Unit<?>`	`inverse()`
`boolean`	`isCompatible(javax.measure.Unit<?> that)`
`boolean`	`isEquivalentTo(javax.measure.Unit<javax.measure.quantity.Length> that)`
`javax.measure.Unit<javax.measure.quantity.Length>`	`multiply(double factor)`
`javax.measure.Unit<javax.measure.quantity.Length>`	`multiply(Number multiplier)`
`javax.measure.Unit<?>`	`multiply(javax.measure.Unit<?> that)`
`javax.measure.Unit<?>`	`pow(int n)`
`javax.measure.Unit<javax.measure.quantity.Length>`	`prefix(javax.measure.Prefix prefix)`
`javax.measure.Unit<?>`	`root(int n)`
`javax.measure.Unit<javax.measure.quantity.Length>`	`shift(double v)`
`javax.measure.Unit<javax.measure.quantity.Length>`	`shift(Number offset)`
`javax.measure.Unit<javax.measure.quantity.Length>`	`transform(javax.measure.UnitConverter operation)`
`static DistanceUnit`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static DistanceUnit[]`	`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, toString, wait, wait, wait

Methods inherited from interface javax.measure.Unit
toString

Methods inherited from interface tech.uom.lib.common.util.DescriptiveEnum
name

- Enum Constant Detail
  - METRE
```
public static final DistanceUnit METRE
```
  - KILOMETRE
```
public static final DistanceUnit KILOMETRE
```
- Method Detail
  - values
```
public static DistanceUnit[] 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 (DistanceUnit c : DistanceUnit.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static DistanceUnit 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
  - getSymbol
```
public String getSymbol()
```
    Specified by:
    
    getSymbol in interface javax.measure.Unit<javax.measure.quantity.Length>
  - getFactor
```
public double getFactor()
```
    Specified by:
    
    getFactor in interface tech.uom.lib.common.function.DoubleFactorSupplier
  - getSystemUnit
```
public javax.measure.Unit<javax.measure.quantity.Length> getSystemUnit()
```
    Specified by:
    
    getSystemUnit in interface javax.measure.Unit<javax.measure.quantity.Length>
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface javax.measure.Unit<javax.measure.quantity.Length>
  - getBaseUnits
```
public Map<? extends javax.measure.Unit<javax.measure.quantity.Length>,Integer> getBaseUnits()
```
    Specified by:
    
    getBaseUnits in interface javax.measure.Unit<javax.measure.quantity.Length>
  - getBySymbol
```
public static DistanceUnit getBySymbol(String symbol)
```
  - getConverterTo
```
public javax.measure.UnitConverter getConverterTo(javax.measure.Unit<javax.measure.quantity.Length> that)
                                           throws javax.measure.UnconvertibleException
```
    Specified by:
    
    getConverterTo in interface javax.measure.Unit<javax.measure.quantity.Length>
    
    Throws:
    
    javax.measure.UnconvertibleException
  - getConverterToAny
```
public javax.measure.UnitConverter getConverterToAny(javax.measure.Unit<?> that)
                                              throws javax.measure.IncommensurableException,
                                                     javax.measure.UnconvertibleException
```
    Specified by:
    
    getConverterToAny in interface javax.measure.Unit<javax.measure.quantity.Length>
    
    Throws:
    
    javax.measure.IncommensurableException
    
    javax.measure.UnconvertibleException
  - alternate
```
public javax.measure.Unit<javax.measure.quantity.Length> alternate(String s)
```
    Specified by:
    
    alternate in interface javax.measure.Unit<javax.measure.quantity.Length>
  - getDimension
```
public javax.measure.Dimension getDimension()
```
    Specified by:
    
    getDimension in interface javax.measure.Unit<javax.measure.quantity.Length>
  - inverse
```
public javax.measure.Unit<?> inverse()
```
    Specified by:
    
    inverse in interface javax.measure.Unit<javax.measure.quantity.Length>
  - divide
```
public javax.measure.Unit<javax.measure.quantity.Length> divide(double v)
```
    Specified by:
    
    divide in interface javax.measure.Unit<javax.measure.quantity.Length>
  - divide
```
public javax.measure.Unit<?> divide(javax.measure.Unit<?> unit)
```
    Specified by:
    
    divide in interface javax.measure.Unit<javax.measure.quantity.Length>
  - isCompatible
```
public boolean isCompatible(javax.measure.Unit<?> that)
```
    Specified by:
    
    isCompatible in interface javax.measure.Unit<javax.measure.quantity.Length>
  - asType
```
public <T extends javax.measure.Quantity<T>> javax.measure.Unit<T> asType(Class<T> tClass)
```
    Specified by:
    
    asType in interface javax.measure.Unit<javax.measure.quantity.Length>
  - multiply
```
public javax.measure.Unit<javax.measure.quantity.Length> multiply(double factor)
```
    Specified by:
    
    multiply in interface javax.measure.Unit<javax.measure.quantity.Length>
  - multiply
```
public javax.measure.Unit<?> multiply(javax.measure.Unit<?> that)
```
    Specified by:
    
    multiply in interface javax.measure.Unit<javax.measure.quantity.Length>
  - pow
```
public javax.measure.Unit<?> pow(int n)
```
    Specified by:
    
    pow in interface javax.measure.Unit<javax.measure.quantity.Length>
  - root
```
public javax.measure.Unit<?> root(int n)
```
    Specified by:
    
    root in interface javax.measure.Unit<javax.measure.quantity.Length>
  - transform
```
public javax.measure.Unit<javax.measure.quantity.Length> transform(javax.measure.UnitConverter operation)
```
    Specified by:
    
    transform in interface javax.measure.Unit<javax.measure.quantity.Length>
  - shift
```
public javax.measure.Unit<javax.measure.quantity.Length> shift(double v)
```
    Specified by:
    
    shift in interface javax.measure.Unit<javax.measure.quantity.Length>
  - getDescription
```
public String getDescription()
```
    Specified by:
    
    getDescription in interface tech.uom.lib.common.function.DescriptionSupplier
    
    Specified by:
    
    getDescription in interface tech.uom.lib.common.util.DescriptiveEnum<DistanceUnit>
  - dValues
```
public tech.uom.lib.common.util.DescriptiveEnum<DistanceUnit>[] dValues()
```
    Specified by:
    
    dValues in interface tech.uom.lib.common.util.DescriptiveEnum<DistanceUnit>
  - prefix
```
public javax.measure.Unit<javax.measure.quantity.Length> prefix(javax.measure.Prefix prefix)
```
    Specified by:
    
    prefix in interface javax.measure.Unit<javax.measure.quantity.Length>
  - shift
```
public javax.measure.Unit<javax.measure.quantity.Length> shift(Number offset)
```
    Specified by:
    
    shift in interface javax.measure.Unit<javax.measure.quantity.Length>
  - multiply
```
public javax.measure.Unit<javax.measure.quantity.Length> multiply(Number multiplier)
```
    Specified by:
    
    multiply in interface javax.measure.Unit<javax.measure.quantity.Length>
  - divide
```
public javax.measure.Unit<javax.measure.quantity.Length> divide(Number divisor)
```
    Specified by:
    
    divide in interface javax.measure.Unit<javax.measure.quantity.Length>
  - isEquivalentTo
```
public boolean isEquivalentTo(javax.measure.Unit<javax.measure.quantity.Length> that)
```
    Specified by:
    
    isEquivalentTo in interface javax.measure.Unit<javax.measure.quantity.Length>

Enum DistanceUnit

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface javax.measure.Unit

Methods inherited from interface tech.uom.lib.common.util.DescriptiveEnum

Enum Constant Detail

METRE

KILOMETRE

Method Detail

values

valueOf

getSymbol

getFactor

getSystemUnit

getName

getBaseUnits

getBySymbol

getConverterTo

getConverterToAny

alternate

getDimension

inverse

divide

divide

isCompatible

asType

multiply

multiply

pow

root

transform

shift

getDescription

dValues

prefix

shift

multiply

divide

isEquivalentTo