RationalConverter (Units of Measurement Reference Implementation 2.0-EDR API)

java.lang.Object
- tech.units.indriya.AbstractConverter
- - tech.units.indriya.function.RationalConverter

All Implemented Interfaces:

Serializable, Comparable<javax.measure.UnitConverter>, DoubleSupplier, Supplier<Double>, javax.measure.UnitConverter, tech.uom.lib.common.function.Converter<Number,Number>, tech.uom.lib.common.function.ValueSupplier<Double>
```
public final class RationalConverter
extends AbstractConverter
implements tech.uom.lib.common.function.ValueSupplier<Double>, Supplier<Double>, DoubleSupplier
```
This class represents a converter multiplying numeric values by an exact scaling factor (represented as the quotient of two BigInteger numbers).

Since:

1.0

Version:

1.0, Oct 11, 2016

Author:

Jean-Marie Dautelle, Werner Keil

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class tech.units.indriya.AbstractConverter
  AbstractConverter.Pair

Field Summary
- Fields inherited from class tech.units.indriya.AbstractConverter
  conversionSteps, IDENTITY

Constructor Summary

Constructors
Constructor and Description
`RationalConverter(BigInteger dividend, BigInteger divisor)` Creates a rational converter with the specified dividend and divisor.
`RationalConverter(long dividend, long divisor)` Convenience method equivalent to `new RationalConverter(BigInteger.valueOf(dividend), BigInteger.valueOf(divisor))`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(javax.measure.UnitConverter o)`
`BigDecimal`	`convertWhenNotIdentity(BigDecimal value, MathContext ctx)` Non-API
`protected Number`	`convertWhenNotIdentity(BigInteger value, MathContext ctx)` Non-API
`double`	`convertWhenNotIdentity(double value)` Non-API
`boolean`	`equals(Object obj)`
`Double`	`get()`
`double`	`getAsDouble()`
`BigInteger`	`getDividend()` Returns the integer dividend for this rational converter.
`BigInteger`	`getDivisor()` Returns the integer (positive) divisor for this rational converter.
`Double`	`getValue()`
`int`	`hashCode()`
`RationalConverter`	`inverseWhenNotIdentity()` Non-API
`boolean`	`isIdentity()`
`boolean`	`isLinear()`
`protected boolean`	`isSimpleCompositionWith(AbstractConverter that)` Non-API Guard for `AbstractConverter.simpleCompose(AbstractConverter)`
`static RationalConverter`	`of(BigInteger dividend, BigInteger divisor)` Convenience method equivalent to `new RationalConverter(dividend, divisor)`
`static RationalConverter`	`of(double dividend, double divisor)` Convenience method equivalent to `new RationalConverter(BigDecimal.valueOf(dividend).toBigInteger(), BigDecimal.valueOf(divisor).toBigInteger())`
`static RationalConverter`	`of(long dividend, long divisor)` Convenience method equivalent to `new RationalConverter(dividend, divisor)`
`protected AbstractConverter`	`simpleCompose(AbstractConverter that)` Non-API Guarded by `AbstractConverter.isSimpleCompositionWith(AbstractConverter)`
`String`	`transformationLiteral()` Non-API

Methods inherited from class tech.units.indriya.AbstractConverter
concatenate, convert, convert, getConversionSteps, inverse, of, toString

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

- Constructor Detail
  - RationalConverter
```
public RationalConverter(BigInteger dividend,
                         BigInteger divisor)
```
    Creates a rational converter with the specified dividend and divisor.
    
    Parameters:
    
    dividend - the dividend.
    
    divisor - the positive divisor.
    
    Throws:
    
    IllegalArgumentException - if divisor <= 0
  - RationalConverter
```
public RationalConverter(long dividend,
                         long divisor)
```
    Convenience method equivalent to new RationalConverter(BigInteger.valueOf(dividend), BigInteger.valueOf(divisor))
    
    Parameters:
    
    dividend - the dividend.
    
    divisor - the positive divisor.
    
    Throws:
    
    IllegalArgumentException - if divisor <= 0
    
    IllegalArgumentException - if dividend == divisor
- Method Detail
  - of
```
public static RationalConverter of(BigInteger dividend,
                                   BigInteger divisor)
```
    Convenience method equivalent to new RationalConverter(dividend, divisor)
    
    Parameters:
    
    dividend - the dividend.
    
    divisor - the positive divisor.
    
    Throws:
    
    IllegalArgumentException - if divisor <= 0
    
    IllegalArgumentException - if dividend == divisor
  - of
```
public static RationalConverter of(long dividend,
                                   long divisor)
```
    Convenience method equivalent to new RationalConverter(dividend, divisor)
    
    Parameters:
    
    dividend - the dividend.
    
    divisor - the positive divisor.
    
    Throws:
    
    IllegalArgumentException - if divisor <= 0
    
    IllegalArgumentException - if dividend == divisor
  - of
```
public static RationalConverter of(double dividend,
                                   double divisor)
```
    Convenience method equivalent to new RationalConverter(BigDecimal.valueOf(dividend).toBigInteger(), BigDecimal.valueOf(divisor).toBigInteger())
    
    Parameters:
    
    dividend - the dividend.
    
    divisor - the positive divisor.
    
    Throws:
    
    IllegalArgumentException - if divisor <= 0
    
    IllegalArgumentException - if dividend == divisor
  - getDividend
```
public BigInteger getDividend()
```
    Returns the integer dividend for this rational converter.
    
    Returns:
    
    this converter dividend.
  - getDivisor
```
public BigInteger getDivisor()
```
    Returns the integer (positive) divisor for this rational converter.
    
    Returns:
    
    this converter divisor.
  - convertWhenNotIdentity
```
public double convertWhenNotIdentity(double value)
```
    Description copied from class: AbstractConverter
    
    Non-API
    
    Specified by:
    
    convertWhenNotIdentity in class AbstractConverter
    
    Returns:
    
    transformed value
  - convertWhenNotIdentity
```
protected Number convertWhenNotIdentity(BigInteger value,
                                        MathContext ctx)
```
    Description copied from class: AbstractConverter
    
    Non-API
    
    Overrides:
    
    convertWhenNotIdentity in class AbstractConverter
    
    Returns:
    
    transformed value (most likely a BigInteger or BigDecimal)
  - convertWhenNotIdentity
```
public BigDecimal convertWhenNotIdentity(BigDecimal value,
                                         MathContext ctx)
                                  throws ArithmeticException
```
    Description copied from class: AbstractConverter
    
    Non-API
    
    Specified by:
    
    convertWhenNotIdentity in class AbstractConverter
    
    Returns:
    
    transformed value
    
    Throws:
    
    ArithmeticException
  - isIdentity
```
public boolean isIdentity()
```
    Specified by:
    
    isIdentity in interface javax.measure.UnitConverter
  - isSimpleCompositionWith
```
protected boolean isSimpleCompositionWith(AbstractConverter that)
```
    Description copied from class: AbstractConverter
    
    Non-API Guard for AbstractConverter.simpleCompose(AbstractConverter)
    
    Specified by:
    
    isSimpleCompositionWith in class AbstractConverter
    
    Returns:
    
    whether or not a 'simple' composition of transformations is possible
  - simpleCompose
```
protected AbstractConverter simpleCompose(AbstractConverter that)
```
    Description copied from class: AbstractConverter
    
    Non-API Guarded by AbstractConverter.isSimpleCompositionWith(AbstractConverter)
    
    Overrides:
    
    simpleCompose in class AbstractConverter
    
    Returns:
    
    a new AbstractConverter that adds no additional conversion step
  - inverseWhenNotIdentity
```
public RationalConverter inverseWhenNotIdentity()
```
    Description copied from class: AbstractConverter
    
    Non-API
    Returns an AbstractConverter that represents the inverse transformation of this converter, for cases where the transformation is not the identity transformation.
    
    Specified by:
    
    inverseWhenNotIdentity in class AbstractConverter
    
    Returns:
  - transformationLiteral
```
public final String transformationLiteral()
```
    Description copied from class: AbstractConverter
    
    Non-API
    Returns a String describing the transformation that is represented by this converter. Contributes to converter's toString method. If null or empty toString output becomes simplified.
    
    Specified by:
    
    transformationLiteral in class AbstractConverter
    
    Returns:
  - equals
```
public boolean equals(Object obj)
```
    Specified by:
    
    equals in class AbstractConverter
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in class AbstractConverter
  - isLinear
```
public boolean isLinear()
```
    Specified by:
    
    isLinear in interface javax.measure.UnitConverter
  - getValue
```
public Double getValue()
```
    Specified by:
    
    getValue in interface tech.uom.lib.common.function.ValueSupplier<Double>
  - getAsDouble
```
public double getAsDouble()
```
    Specified by:
    
    getAsDouble in interface DoubleSupplier
  - get
```
public Double get()
```
    Specified by:
    
    get in interface Supplier<Double>
  - compareTo
```
public int compareTo(javax.measure.UnitConverter o)
```
    Specified by:
    
    compareTo in interface Comparable<javax.measure.UnitConverter>

Class RationalConverter

Nested Class Summary

Nested classes/interfaces inherited from class tech.units.indriya.AbstractConverter

Field Summary

Fields inherited from class tech.units.indriya.AbstractConverter

Constructor Summary

Method Summary

Methods inherited from class tech.units.indriya.AbstractConverter

Methods inherited from class java.lang.Object

Constructor Detail

RationalConverter

RationalConverter

Method Detail

of

of

of

getDividend

getDivisor

convertWhenNotIdentity

convertWhenNotIdentity

convertWhenNotIdentity

isIdentity

isSimpleCompositionWith

simpleCompose

inverseWhenNotIdentity

transformationLiteral

equals

hashCode

isLinear

getValue

getAsDouble

get

compareTo