Units of Measurement Reference Implementation 2.2.2 · tech.units.indriya.function.RationalConverter

Modifier and Type	Field and Description
private final RationalNumber	factor Holds the scale factor.
private static final long	serialVersionUID Hides tech.units.indriya.function.AbstractConverter.serialVersionUID.

Access	Constructor and Description
pack-priv	RationalConverter(RationalNumber the scale factor. factor) Creates a rational converter with the specified scale factor.
pack-priv	RationalConverter(BigInteger the dividend. dividend, BigInteger the non-zero divisor. divisor) Creates a rational converter with the specified dividend and divisor.
pack-priv	RationalConverter(long the dividend. dividend, long the positive divisor. divisor) Convenience method equivalent to `new RationalConverter(BigInteger.valueOf(dividend), BigInteger.valueOf(divisor))`

Method Summary

Modifier and Type	Method and Description
protected boolean	canReduceWith(AbstractConverter that) Implements abstract tech.units.indriya.function.AbstractConverter.canReduceWith. Non-API Guard for `reduce(AbstractConverter)`
public int	compareTo(UnitConverter the object to be compared. o) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
private AbstractConverter	composeSameType(RationalConverter that)
protected Number	convertWhenNotIdentity(Number value) Implements abstract tech.units.indriya.function.AbstractConverter.convertWhenNotIdentity. Non-API
public boolean	equals(Object the reference object with which to compare. obj) Implements abstract tech.units.indriya.function.AbstractConverter.equals. Indicates whether some other object is "equal to" this one.
public double	getAsDouble() Implements java.util.function.DoubleSupplier.getAsDouble. Gets a result.
public BigInteger	Returns: this converter dividend. getDividend() Returns the integer dividend for this rational converter.
public BigInteger	Returns: this converter divisor. getDivisor() Returns the integer (positive) divisor for this rational converter.
public Number	getValue() Implements tech.uom.lib.common.function.ValueSupplier.getValue. Gets a value.
public int	hashCode() Implements abstract tech.units.indriya.function.AbstractConverter.hashCode. Returns a hash code value for this object.
protected RationalConverter	inverseWhenNotIdentity() Implements abstract tech.units.indriya.function.AbstractConverter.inverseWhenNotIdentity. Non-API Returns an AbstractConverter that represents the inverse transformation of this converter, for cases where the transformation is not the identity transformation.
public boolean	isIdentity() Implements javax.measure.UnitConverter.isIdentity. Indicates if this converter is an identity converter.
pack-priv static RationalConverter	of(RationalNumber the scale factor. factor) Creates a rational converter with the specified scale factor.
pack-priv static RationalConverter	of(BigInteger the dividend. dividend, BigInteger the positive divisor. divisor) Convenience method equivalent to `new RationalConverter(dividend, divisor)`
pack-priv static RationalConverter	of(long the dividend. dividend, long the positive divisor. divisor) Convenience method equivalent to `new RationalConverter(dividend, divisor)`
protected AbstractConverter	reduce(AbstractConverter that) Overrides tech.units.indriya.function.AbstractConverter.reduce. Non-API Guarded by `canReduceWith(AbstractConverter)`
protected final String	transformationLiteral() Implements abstract tech.units.indriya.function.AbstractConverter.transformationLiteral. Non-API Returns a String describing the transformation that is represented by this converter.

Inherited from tech.units.indriya.function.AbstractConverter:: concatenate convert convert getConversionSteps inverse linearFactor toString

factor	back to summary
private final RationalNumber factor Holds the scale factor.

serialVersionUID	back to summary
private static final long serialVersionUID Hides tech.units.indriya.function.AbstractConverter.serialVersionUID.

RationalConverter	back to summary
pack-priv RationalConverter(RationalNumber factor) Creates a rational converter with the specified scale factor. Parameters factor:RationalNumber the scale factor. Exceptions NullPointerException: if factor is `null`

RationalConverter	back to summary
pack-priv RationalConverter(BigInteger dividend, BigInteger divisor) Creates a rational converter with the specified dividend and divisor. Parameters dividend:BigInteger the dividend. divisor:BigInteger the non-zero divisor. Exceptions IllegalArgumentException: if `divisor = 0` NullPointerException: if dividend is `null` or divisor is `null`

RationalConverter	back to summary
pack-priv RationalConverter(long dividend, long divisor) Convenience method equivalent to `new RationalConverter(BigInteger.valueOf(dividend), BigInteger.valueOf(divisor))` Parameters dividend:long the dividend. divisor:long the positive divisor. Exceptions IllegalArgumentException: if `divisor = 0`

Method Detail

canReduceWith back to summary

canReduceWith	back to summary
protected boolean canReduceWith(AbstractConverter that) Implements abstract tech.units.indriya.function.AbstractConverter.canReduceWith. Doc from tech.units.indriya.function.AbstractConverter.canReduceWith. Non-API Guard for `reduce(AbstractConverter)` Returns:boolean 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 Annotations @Override

protected boolean canReduceWith(AbstractConverter that)

Implements abstract tech.units.indriya.function.AbstractConverter.canReduceWith.

Doc from tech.units.indriya.function.AbstractConverter.canReduceWith.

Non-API Guard for reduce(AbstractConverter)

Returns:boolean

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

Annotations

@Override

compareTo back to summary

compareTo	back to summary
public int compareTo(UnitConverter o) Implements java.lang.Comparable.compareTo. Doc from java.lang.Comparable.compareTo. Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The implementor must ensure `signum(x.compareTo(y)) == -signum(y.compareTo(x))` for all `x` and `y`. (This implies that `x.compareTo(y)` must throw an exception if and only if `y.compareTo(x)` throws an exception.) The implementor must also ensure that the relation is transitive: `(x.compareTo(y) > 0 && y.compareTo(z) > 0)` implies `x.compareTo(z) > 0`. Finally, the implementor must ensure that `x.compareTo(y)==0` implies that `signum(x.compareTo(z)) == signum(y.compareTo(z))`, for all `z`. Parameters o:UnitConverter the object to be compared. Returns:int a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. Annotations @Override

public int compareTo(UnitConverter o)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters

o:UnitConverter: the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations

@Override

composeSameType	back to summary
private AbstractConverter composeSameType(RationalConverter that)

convertWhenNotIdentity	back to summary
protected Number convertWhenNotIdentity(Number value) Implements abstract tech.units.indriya.function.AbstractConverter.convertWhenNotIdentity. Doc from tech.units.indriya.function.AbstractConverter.convertWhenNotIdentity. Non-API Returns:Number transformed value Annotations @Override

convertWhenNotIdentity

back to summary

protected Number convertWhenNotIdentity(Number value)

Implements abstract tech.units.indriya.function.AbstractConverter.convertWhenNotIdentity.

Doc from tech.units.indriya.function.AbstractConverter.convertWhenNotIdentity.

Non-API

Returns:Number

transformed value

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object obj) Implements abstract tech.units.indriya.function.AbstractConverter.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Implements abstract tech.units.indriya.function.AbstractConverter.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getAsDouble	back to summary
public double getAsDouble() Implements java.util.function.DoubleSupplier.getAsDouble. Doc from java.util.function.DoubleSupplier.getAsDouble. Gets a result. Returns:double a result Annotations @Override

getAsDouble

back to summary

public double getAsDouble()

Implements java.util.function.DoubleSupplier.getAsDouble.

Doc from java.util.function.DoubleSupplier.getAsDouble.

Gets a result.

Returns:double

a result

Annotations

@Override

getDividend	back to summary
public BigInteger getDividend() Returns the integer dividend for this rational converter. Returns:BigInteger this converter dividend.

getDividend

back to summary

public BigInteger getDividend()

Returns the integer dividend for this rational converter.

Returns:BigInteger: this converter dividend.

getDivisor	back to summary
public BigInteger getDivisor() Returns the integer (positive) divisor for this rational converter. Returns:BigInteger this converter divisor.

getDivisor

back to summary

public BigInteger getDivisor()

Returns the integer (positive) divisor for this rational converter.

Returns:BigInteger: this converter divisor.

getValue	back to summary
public Number getValue() Implements tech.uom.lib.common.function.ValueSupplier.getValue. Doc from tech.uom.lib.common.function.ValueSupplier.getValue. Gets a value. Returns:Number a value Annotations @Override

getValue

back to summary

public Number getValue()

Implements tech.uom.lib.common.function.ValueSupplier.getValue.

Doc from tech.uom.lib.common.function.ValueSupplier.getValue.

Gets a value.

Returns:Number

a value

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Implements abstract tech.units.indriya.function.AbstractConverter.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Implements abstract tech.units.indriya.function.AbstractConverter.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

inverseWhenNotIdentity	back to summary
protected RationalConverter inverseWhenNotIdentity() Implements abstract tech.units.indriya.function.AbstractConverter.inverseWhenNotIdentity. Doc from tech.units.indriya.function.AbstractConverter.inverseWhenNotIdentity. Non-API Returns an AbstractConverter that represents the inverse transformation of this converter, for cases where the transformation is not the identity transformation. Annotations @Override

inverseWhenNotIdentity

back to summary

protected RationalConverter inverseWhenNotIdentity()

Implements abstract tech.units.indriya.function.AbstractConverter.inverseWhenNotIdentity.

Doc from tech.units.indriya.function.AbstractConverter.inverseWhenNotIdentity.

Non-API

Returns an AbstractConverter that represents the inverse transformation of this converter, for cases where the transformation is not the identity transformation.

Annotations

@Override

isIdentity back to summary

isIdentity	back to summary
public boolean isIdentity() Implements javax.measure.UnitConverter.isIdentity. Doc from javax.measure.UnitConverter.isIdentity. Indicates if this converter is an identity converter. The identity converter returns its input argument (`convert(x) == x`). Note Identity converters are also always 'linear', see `UnitConverter#isLinear()`. Returns:boolean `true` if this converter is an identity converter. Annotations @Override

public boolean isIdentity()

Implements javax.measure.UnitConverter.isIdentity.

Doc from javax.measure.UnitConverter.isIdentity.

Indicates if this converter is an identity converter. The identity converter returns its input argument (convert(x) == x).

Note

Identity converters are also always 'linear', see UnitConverter#isLinear().

Returns:boolean

true if this converter is an identity converter.

Annotations

@Override

of back to summary

of	back to summary
pack-priv static RationalConverter of(RationalNumber factor) Creates a rational converter with the specified scale factor. Parameters factor:RationalNumber the scale factor. Exceptions NullPointerException: if factor is `null`

pack-priv static RationalConverter of(RationalNumber factor)

Creates a rational converter with the specified scale factor.

Parameters

factor:RationalNumber: the scale factor.

Exceptions

NullPointerException:: if factor is null

of back to summary

of	back to summary
pack-priv static RationalConverter of(BigInteger dividend, BigInteger divisor) Convenience method equivalent to `new RationalConverter(dividend, divisor)` Parameters dividend:BigInteger the dividend. divisor:BigInteger the positive divisor. Exceptions IllegalArgumentException: if `divisor = 0` NullPointerException: if dividend is `null` or divisor is `null`

pack-priv static RationalConverter of(BigInteger dividend, BigInteger divisor)

Convenience method equivalent to new RationalConverter(dividend, divisor)

Parameters

dividend:BigInteger: the dividend.
divisor:BigInteger: the positive divisor.

Exceptions

IllegalArgumentException:: if divisor = 0
NullPointerException:: if dividend is null or divisor is null

of back to summary

of	back to summary
pack-priv static RationalConverter of(long dividend, long divisor) Convenience method equivalent to `new RationalConverter(dividend, divisor)` Parameters dividend:long the dividend. divisor:long the positive divisor. Exceptions IllegalArgumentException: if `divisor = 0`

pack-priv static RationalConverter of(long dividend, long divisor)

Convenience method equivalent to new RationalConverter(dividend, divisor)

Parameters

dividend:long: the dividend.
divisor:long: the positive divisor.

Exceptions

IllegalArgumentException:: if divisor = 0

reduce back to summary

reduce	back to summary
protected AbstractConverter reduce(AbstractConverter that) Overrides tech.units.indriya.function.AbstractConverter.reduce. Doc from tech.units.indriya.function.AbstractConverter.reduce. Non-API Guarded by `canReduceWith(AbstractConverter)` Returns:AbstractConverter a new AbstractConverter that adds no additional conversion steps, with respect to the steps already in place by this converter Annotations @Override

protected AbstractConverter reduce(AbstractConverter that)

Overrides tech.units.indriya.function.AbstractConverter.reduce.

Doc from tech.units.indriya.function.AbstractConverter.reduce.

Non-API Guarded by canReduceWith(AbstractConverter)

Returns:AbstractConverter

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

Annotations

@Override

transformationLiteral back to summary

transformationLiteral	back to summary
protected final String transformationLiteral() Implements abstract tech.units.indriya.function.AbstractConverter.transformationLiteral. Doc from tech.units.indriya.function.AbstractConverter.transformationLiteral. 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. Annotations @Override

protected final String transformationLiteral()

Implements abstract tech.units.indriya.function.AbstractConverter.transformationLiteral.

Doc from tech.units.indriya.function.AbstractConverter.transformationLiteral.

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.

Annotations

@Override

public final Class RationalConverter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail