tec.uom.se.function

Class MultiplyConverter

java.lang.Object

tec.uom.se.AbstractConverter

tec.uom.se.function.MultiplyConverter

All Implemented Interfaces:

Serializable, javax.measure.UnitConverter, tec.uom.lib.common.function.DoubleFactorSupplier, tec.uom.lib.common.function.ValueSupplier<Double>, Converter<Number,Number>

public final class MultiplyConverter
extends AbstractConverter
implements tec.uom.lib.common.function.ValueSupplier<Double>, tec.uom.lib.common.function.DoubleFactorSupplier

This class represents a converter multiplying numeric values by a constant scaling factor (double based).

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 tec.uom.se.AbstractConverter

AbstractConverter.Pair

Field Summary

Fields inherited from class tec.uom.se.AbstractConverter

IDENTITY, PI

Constructor Summary

Constructors

Constructor and Description
MultiplyConverter(double factor) Creates a multiply converter with the specified scale factor.

Method Summary

Modifier and Type	Method and Description
javax.measure.UnitConverter	concatenate(javax.measure.UnitConverter converter)
BigDecimal	convert(BigDecimal value, MathContext ctx)
double	convert(double value)
boolean	equals(Object obj)
double	getFactor() Returns the scale factor of this converter.
Double	getValue()
int	hashCode()
MultiplyConverter	inverse()
boolean	isLinear()
String	toString()

Methods inherited from class tec.uom.se.AbstractConverter

concatenate, convert, getConversionSteps, isIdentity

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiplyConverter

public MultiplyConverter(double factor)

Creates a multiply converter with the specified scale factor.

Parameters:

factor - the scaling factor.

Throws:

IllegalArgumentException - if coefficient is 1.0 (would result in identity converter)

Method Detail

getFactor

public double getFactor()

Returns the scale factor of this converter.

Specified by:

getFactor in interface tec.uom.lib.common.function.DoubleFactorSupplier

Returns:

the scale factor.

concatenate

public javax.measure.UnitConverter concatenate(javax.measure.UnitConverter converter)

Specified by:

concatenate in interface javax.measure.UnitConverter

Overrides:

concatenate in class AbstractConverter

inverse

public MultiplyConverter inverse()

Specified by:

inverse in interface javax.measure.UnitConverter

Specified by:

inverse in class AbstractConverter

convert

public double convert(double value)

Specified by:

convert in interface javax.measure.UnitConverter

Specified by:

convert in class AbstractConverter

convert

public BigDecimal convert(BigDecimal value,
                          MathContext ctx)
                   throws ArithmeticException

Specified by:

convert in class AbstractConverter

Throws:

ArithmeticException

toString

public final String toString()

Overrides:

toString in class Object

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 tec.uom.lib.common.function.ValueSupplier<Double>