Top Fields Constructors Methods
tech.units.indriya.function

pack-priv final Class IdentityMultiplyConverter

extends Object
implements MultiplyConverter, Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable, tech.units.indriya.function.MultiplyConverter, java.lang.Comparable, java.util.function.DoubleSupplier, tech.uom.lib.common.function.FactorSupplier, tech.uom.lib.common.function.ValueSupplier, tech.uom.lib.common.function.Converter, javax.measure.UnitConverter
Imports
java.io.Serializable, java.util.Collections, .List, .Objects, javax.measure.UnitConverter

Authors
Andi Huber, Werner Keil
Since
2.0

Field Summary

Modifier and TypeField and Description
pack-priv static final IdentityMultiplyConverter
private static final long

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public int
compareTo(UnitConverter
the object to be compared.
o
)

Implements java.lang.Comparable.compareTo.

Compares this object with the specified object for order.

public UnitConverter
concatenate(UnitConverter
the other converter to concatenate with this converter.
converter
)

Implements javax.measure.UnitConverter.concatenate.

Concatenates this converter with another converter.

public Number
convert(Number
the Number value to convert.
value
)

Implements javax.measure.UnitConverter.convert, tech.uom.lib.common.function.Converter.convert.

Converts a Number value.

public double
convert(double
the numeric value to convert.
value
)

Implements javax.measure.UnitConverter.convert, tech.uom.lib.common.function.Converter.convert.

Converts a double value.

public boolean
equals(Object
the reference object with which to compare.
obj
)

Overrides java.lang.Object.equals.

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

public double
public List<? extends UnitConverter>
getConversionSteps()

Implements javax.measure.UnitConverter.getConversionSteps.

Returns the steps of fundamental converters making up this converter or this if the converter is a fundamental converter.

public Number
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public UnitConverter
inverse()

Implements javax.measure.UnitConverter.inverse.

Returns the inverse of this converter.

public boolean
isIdentity()

Implements javax.measure.UnitConverter.isIdentity.

Indicates if this converter is an identity converter.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

INSTANCEback to summary
pack-priv static final IdentityMultiplyConverter INSTANCE
serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

IdentityMultiplyConverterback to summary
private IdentityMultiplyConverter()

Method Detail

compareToback 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
concatenateback to summary
public UnitConverter concatenate(UnitConverter converter)

Implements javax.measure.UnitConverter.concatenate.

Doc from javax.measure.UnitConverter.concatenate.

Concatenates this converter with another converter. The resulting converter is equivalent to first converting by the specified converter (right converter), and then converting by this converter (left converter).

Parameters
converter:UnitConverter

the other converter to concatenate with this converter.

Returns:UnitConverter

the concatenation of this converter with the other converter.

Annotations
@Override
convertback to summary
public Number convert(Number value)

Implements javax.measure.UnitConverter.convert, tech.uom.lib.common.function.Converter.convert.

Doc from javax.measure.UnitConverter.convert.

Converts a Number value.

Parameters
value:Number

the Number value to convert.

Returns:Number

the Number value after conversion.

Annotations
@Override
convertback to summary
public double convert(double value)

Implements javax.measure.UnitConverter.convert, tech.uom.lib.common.function.Converter.convert.

Doc from javax.measure.UnitConverter.convert.

Converts a double value.

Parameters
value:double

the numeric value to convert.

Returns:double

the double value after conversion.

Annotations
@Override
equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.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
getAsDoubleback 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
getConversionStepsback to summary
public List<? extends UnitConverter> getConversionSteps()

Implements javax.measure.UnitConverter.getConversionSteps.

Doc from javax.measure.UnitConverter.getConversionSteps.

Returns the steps of fundamental converters making up this converter or this if the converter is a fundamental converter.

For example, converter1.getConversionSteps() returns converter1 while converter1.concatenate(converter2).getConversionSteps() returns converter1, converter2.

Returns:List<? extends UnitConverter>

the list of fundamental converters which concatenated make up this converter.

Annotations
@Override
getValueback 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
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.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
inverseback to summary
public UnitConverter inverse()

Implements javax.measure.UnitConverter.inverse.

Doc from javax.measure.UnitConverter.inverse.

Returns the inverse of this converter. If x is a valid value, then x == inverse().convert(convert(x)) to within the accuracy of computer arithmetic.

Returns:UnitConverter

the inverse of this converter.

Annotations
@Override
isIdentityback 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