MixedUnit (Units of Measurement Enum Implementation 2.1 API)

java.lang.Object
- tech.uom.impl.enums.unit.MixedUnit<Q>

All Implemented Interfaces:

javax.measure.Unit<Q>
```
public final class MixedUnit<Q extends javax.measure.Quantity<Q>>
extends Object
implements javax.measure.Unit<Q>
```
This class represents multi-radix units (such as "hour:min:sec" or "ft, in"). Instances of this class are created using the Unit.mix method.

Examples of mixed units:Unit HOUR_MINUTE_SECOND = HOUR.mix(MINUTE).mix(SECOND); Unit FOOT_INCH = FOOT.mix(INCH);

Since:

2.0

Version:

2.0, Oct 3, 2020

Author:

Jean-Marie Dautelle, Werner Keil

Constructor Summary

Constructors
Constructor and Description

MixedUnit(javax.measure.Unit<Q> up, javax.measure.Unit<Q> low)
Creates a mixed unit from the specified units.

Constructors
Constructor and Description
`MixedUnit(javax.measure.Unit<Q> up, javax.measure.Unit<Q> low)` Creates a mixed unit from the specified units.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`javax.measure.Unit<Q>`	`alternate(String symbol)`
`<T extends javax.measure.Quantity<T>> javax.measure.Unit<T>`	`asType(Class<T> type)`
`javax.measure.Unit<Q>`	`divide(double divisor)`
`javax.measure.Unit<Q>`	`divide(Number divisor)`
`javax.measure.Unit<?>`	`divide(javax.measure.Unit<?> divisor)`
`boolean`	`equals(Object obj)` Indicates if this mixed unit is considered equals to the specified object (both are mixed units with same composing units in the same order).
`Map<? extends javax.measure.Unit<?>,Integer>`	`getBaseUnits()`
`javax.measure.UnitConverter`	`getConverterTo(javax.measure.Unit<Q> that)`
`javax.measure.UnitConverter`	`getConverterToAny(javax.measure.Unit<?> that)`
`javax.measure.Dimension`	`getDimension()`
`javax.measure.Unit<Q>`	`getLower()` Returns the lower unit of this mixed unit.
`String`	`getName()`
`String`	`getSymbol()`
`javax.measure.Unit<Q>`	`getSystemUnit()`
`javax.measure.Unit<Q>`	`getUpper()` Returns the upper unit of this mixed unit.
`int`	`hashCode()`
`javax.measure.Unit<?>`	`inverse()`
`boolean`	`isCompatible(javax.measure.Unit<?> that)`
`boolean`	`isEquivalentTo(javax.measure.Unit<Q> that)`
`javax.measure.Unit<Q>`	`mix(javax.measure.Unit<Q> that)`
`javax.measure.Unit<Q>`	`multiply(double multiplier)`
`javax.measure.Unit<Q>`	`multiply(Number multiplier)`
`javax.measure.Unit<?>`	`multiply(javax.measure.Unit<?> multiplier)`
`javax.measure.Unit<?>`	`pow(int n)`
`javax.measure.Unit<Q>`	`prefix(javax.measure.Prefix prefix)`
`javax.measure.Unit<?>`	`root(int n)`
`javax.measure.Unit<Q>`	`shift(double offset)`
`javax.measure.Unit<Q>`	`shift(Number offset)`
`String`	`toString()` Returns the standard representation of this physics unit.
`javax.measure.Unit<Q>`	`transform(javax.measure.UnitConverter operation)`

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

- Constructor Detail
  - MixedUnit
```
public MixedUnit(javax.measure.Unit<Q> up,
                 javax.measure.Unit<Q> low)
```
    Creates a mixed unit from the specified units.
    
    Parameters:
    
    up - the upper unit.
    
    low - the lower unit(s)
    
    Throws:
    
    IllegalArgumentException - if both units do not the same system unit.
- Method Detail
  - getLower
```
public javax.measure.Unit<Q> getLower()
```
    Returns the lower unit of this mixed unit.
    
    Returns:
    
    the lower unit.
  - getUpper
```
public javax.measure.Unit<Q> getUpper()
```
    Returns the upper unit of this mixed unit.
    
    Returns:
    
    the upper unit.
  - equals
```
public boolean equals(Object obj)
```
    Indicates if this mixed unit is considered equals to the specified object (both are mixed units with same composing units in the same order).
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - the object to compare for equality.
    
    Returns:
    
    true if this and obj are considered equal; falseotherwise.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getSystemUnit
```
public javax.measure.Unit<Q> getSystemUnit()
```
    Specified by:
    
    getSystemUnit in interface javax.measure.Unit<Q extends javax.measure.Quantity<Q>>
  - getDimension
```
public javax.measure.Dimension getDimension()
```
    Specified by:
    
    getDimension in interface javax.measure.Unit<Q extends javax.measure.Quantity<Q>>
  - getSymbol
```
public String getSymbol()
```
    Specified by:
    
    getSymbol in interface javax.measure.Unit<Q extends javax.measure.Quantity<Q>>
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface javax.measure.Unit<Q extends javax.measure.Quantity<Q>>
  - getBaseUnits
```
public Map<? extends javax.measure.Unit<?>,Integer> getBaseUnits()
```
    Specified by:
    
    getBaseUnits in interface javax.measure.Unit<Q extends javax.measure.Quantity<Q>>
  - isCompatible
```
public boolean isCompatible(javax.measure.Unit<?> that)
```
    Specified by:
    
    isCompatible in interface javax.measure.Unit<Q extends javax.measure.Quantity<Q>>
  - asType
```
public <T extends javax.measure.Quantity<T>> javax.measure.Unit<T> asType(Class<T> type)
                                                                   throws ClassCastException
```
    Specified by:
    
    asType in interface javax.measure.Unit<Q extends javax.measure.Quantity<Q>>
    
    Throws:
    
    ClassCastException
  - getConverterTo
```
public javax.measure.UnitConverter getConverterTo(javax.measure.Unit<Q> that)
                                           throws javax.measure.UnconvertibleException
```
    Specified by:
    
    getConverterTo in interface javax.measure.Unit<Q extends javax.measure.Quantity<Q>>
    
    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<Q extends javax.measure.Quantity<Q>>
    
    Throws:
    
    javax.measure.IncommensurableException
    
    javax.measure.UnconvertibleException
  - alternate
```
public javax.measure.Unit<Q> alternate(String symbol)
```
    Specified by:
    
    alternate in interface javax.measure.Unit<Q extends javax.measure.Quantity<Q>>
  - shift
```
public javax.measure.Unit<Q> shift(double offset)
```
    Specified by:
    
    shift in interface javax.measure.Unit<Q extends javax.measure.Quantity<Q>>
  - multiply
```
public javax.measure.Unit<Q> multiply(double multiplier)
```
    Specified by:
    
    multiply in interface javax.measure.Unit<Q extends javax.measure.Quantity<Q>>
  - multiply
```
public javax.measure.Unit<?> multiply(javax.measure.Unit<?> multiplier)
```
    Specified by:
    
    multiply in interface javax.measure.Unit<Q extends javax.measure.Quantity<Q>>
  - inverse
```
public javax.measure.Unit<?> inverse()
```
    Specified by:
    
    inverse in interface javax.measure.Unit<Q extends javax.measure.Quantity<Q>>
  - divide
```
public javax.measure.Unit<Q> divide(double divisor)
```
    Specified by:
    
    divide in interface javax.measure.Unit<Q extends javax.measure.Quantity<Q>>
  - divide
```
public javax.measure.Unit<?> divide(javax.measure.Unit<?> divisor)
```
    Specified by:
    
    divide in interface javax.measure.Unit<Q extends javax.measure.Quantity<Q>>
  - root
```
public javax.measure.Unit<?> root(int n)
```
    Specified by:
    
    root in interface javax.measure.Unit<Q extends javax.measure.Quantity<Q>>
  - pow
```
public javax.measure.Unit<?> pow(int n)
```
    Specified by:
    
    pow in interface javax.measure.Unit<Q extends javax.measure.Quantity<Q>>
  - transform
```
public javax.measure.Unit<Q> transform(javax.measure.UnitConverter operation)
```
    Specified by:
    
    transform in interface javax.measure.Unit<Q extends javax.measure.Quantity<Q>>
  - prefix
```
public javax.measure.Unit<Q> prefix(javax.measure.Prefix prefix)
```
    Specified by:
    
    prefix in interface javax.measure.Unit<Q extends javax.measure.Quantity<Q>>
  - mix
```
public javax.measure.Unit<Q> mix(javax.measure.Unit<Q> that)
```
  - toString
```
public String toString()
```
    Returns the standard representation of this physics unit. The string produced for a given unit is always the same; it is not affected by the locale. It can be used as a canonical string representation for exchanging units, or as a key for a Hashtable, etc. Locale-sensitive unit parsing could be handled using LocalUnitFormat in subclasses of AbstractUnit.
    
    Specified by:
    
    toString in interface javax.measure.Unit<Q extends javax.measure.Quantity<Q>>
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    SimpleUnitFormat.getInstance().format(this)
  - shift
```
public javax.measure.Unit<Q> shift(Number offset)
```
    Specified by:
    
    shift in interface javax.measure.Unit<Q extends javax.measure.Quantity<Q>>
  - multiply
```
public javax.measure.Unit<Q> multiply(Number multiplier)
```
    Specified by:
    
    multiply in interface javax.measure.Unit<Q extends javax.measure.Quantity<Q>>
  - divide
```
public javax.measure.Unit<Q> divide(Number divisor)
```
    Specified by:
    
    divide in interface javax.measure.Unit<Q extends javax.measure.Quantity<Q>>
  - isEquivalentTo
```
public boolean isEquivalentTo(javax.measure.Unit<Q> that)
```
    Specified by:
    
    isEquivalentTo in interface javax.measure.Unit<Q extends javax.measure.Quantity<Q>>

Class MixedUnit<Q extends javax.measure.Quantity<Q>>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MixedUnit

Method Detail

getLower

getUpper

equals

hashCode

getSystemUnit

getDimension

getSymbol

getName

getBaseUnits

isCompatible

asType

getConverterTo

getConverterToAny

alternate

shift

multiply

multiply

inverse

divide

divide

root

pow

transform

prefix

mix

toString

shift

multiply

divide

isEquivalentTo