tech.units.indriya.function

Class RationalConverter

java.lang.Object

tech.units.indriya.function.AbstractConverter

tech.units.indriya.function.RationalConverter

All Implemented Interfaces:

Serializable, Comparable<javax.measure.UnitConverter>, DoubleSupplier, javax.measure.UnitConverter, MultiplyConverter, tech.uom.lib.common.function.Converter<Number,Number>, tech.uom.lib.common.function.FactorSupplier<Number>, tech.uom.lib.common.function.ValueSupplier<Number>

public final class RationalConverter
extends AbstractConverter
implements MultiplyConverter

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:

2.0, October 8, 2020

Author:

Jean-Marie Dautelle, Werner Keil, Andi Huber

See Also:

Serialized Form

Nested Class Summary

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

AbstractConverter.Pair

Field Summary

Fields inherited from class tech.units.indriya.function.AbstractConverter

conversionSteps, IDENTITY, UNIT_COMPOSITION_HANDLER

Method Summary

Modifier and Type	Method and Description
protected boolean	canReduceWith(AbstractConverter that) Non-API Guard for AbstractConverter.reduce(AbstractConverter)
int	compareTo(javax.measure.UnitConverter o)
protected Number	convertWhenNotIdentity(Number value) Non-API
boolean	equals(Object obj)
double	getAsDouble()
BigInteger	getDividend() Returns the integer dividend for this rational converter.
BigInteger	getDivisor() Returns the integer (positive) divisor for this rational converter.
Number	getValue()
int	hashCode()
protected RationalConverter	inverseWhenNotIdentity() Non-API Returns an AbstractConverter that represents the inverse transformation of this converter, for cases where the transformation is not the identity transformation.
boolean	isIdentity()
protected AbstractConverter	reduce(AbstractConverter that) Non-API Guarded by AbstractConverter.canReduceWith(AbstractConverter)
protected String	transformationLiteral() Non-API Returns a String describing the transformation that is represented by this converter.

Methods inherited from class tech.units.indriya.function.AbstractConverter

concatenate, convert, convert, getConversionSteps, inverse, linearFactor, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface tech.units.indriya.function.MultiplyConverter

getFactor, identity, isLinear, of, of, ofExponent, ofPiExponent, ofPrefix, ofRational, ofRational, ofRational, ofTenExponent

Methods inherited from interface javax.measure.UnitConverter

concatenate, convert, convert, getConversionSteps, inverse

Methods inherited from interface tech.uom.lib.common.function.Converter

convert

Method Detail

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

protected Number convertWhenNotIdentity(Number value)

Description copied from class: AbstractConverter

Non-API

Specified by:

convertWhenNotIdentity in class AbstractConverter

Returns:

transformed value

isIdentity

public boolean isIdentity()

Specified by:

isIdentity in interface javax.measure.UnitConverter

canReduceWith

protected boolean canReduceWith(AbstractConverter that)

Description copied from class: AbstractConverter

Non-API Guard for AbstractConverter.reduce(AbstractConverter)

Specified by:

canReduceWith in class AbstractConverter

Returns:

whether or not a composition with given that is possible, such that no additional conversion steps are required, with respect to the steps already in place by this converter

reduce

protected AbstractConverter reduce(AbstractConverter that)

Description copied from class: AbstractConverter

Non-API Guarded by AbstractConverter.canReduceWith(AbstractConverter)

Overrides:

reduce in class AbstractConverter

Returns:

a new AbstractConverter that adds no additional conversion steps, with respect to the steps already in place by this converter

inverseWhenNotIdentity

protected 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

protected 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

getValue

public Number getValue()

Specified by:

getValue in interface tech.uom.lib.common.function.ValueSupplier<Number>

getAsDouble

public double getAsDouble()

Specified by:

getAsDouble in interface DoubleSupplier

compareTo

public int compareTo(javax.measure.UnitConverter o)

Specified by:

compareTo in interface Comparable<javax.measure.UnitConverter>