tech.units.indriya

Class AbstractConverter

java.lang.Object

tech.units.indriya.AbstractConverter

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractConverter.Pair, AddConverter, ExpConverter, LogConverter, MultiplyConverter, PowerOfIntConverter, PowerOfPiConverter, RationalConverter

public abstract class AbstractConverter
extends Object
implements javax.measure.UnitConverter, tech.uom.lib.common.function.Converter<Number,Number>, Serializable, Comparable<javax.measure.UnitConverter>

The base class for our UnitConverter implementations.

Since:

1.0

Version:

1.7, June 29, 2018

Author:

Jean-Marie Dautelle, Werner Keil, Andi Huber

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractConverter.Pair This class represents converters made up of two or more separate converters (in matrix notation [pair] = [left] x [right]).

Field Summary

Fields

Modifier and Type	Field and Description
protected List<? extends javax.measure.UnitConverter>	conversionSteps memoization for getConversionSteps
static AbstractConverter	IDENTITY Holds identity converter.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractConverter() DefaultQuantityFactory constructor.

Method Summary

Modifier and Type	Method and Description
javax.measure.UnitConverter	concatenate(javax.measure.UnitConverter converter)
double	convert(double value)
Number	convert(Number value)
protected abstract BigDecimal	convertWhenNotIdentity(BigDecimal value, MathContext ctx) Non-API
protected Number	convertWhenNotIdentity(BigInteger value, MathContext ctx) Non-API
protected abstract double	convertWhenNotIdentity(double value) Non-API
abstract boolean	equals(Object cvtr)
List<? extends javax.measure.UnitConverter>	getConversionSteps()
abstract int	hashCode()
AbstractConverter	inverse()
protected abstract AbstractConverter	inverseWhenNotIdentity() Non-API
protected abstract boolean	isSimpleCompositionWith(AbstractConverter that) Non-API Guard for simpleCompose(AbstractConverter)
static javax.measure.UnitConverter	of(javax.measure.Prefix prefix) Creates a converter with the specified Prefix.
protected AbstractConverter	simpleCompose(AbstractConverter that) Non-API Guarded by isSimpleCompositionWith(AbstractConverter)
String	toString()
protected abstract String	transformationLiteral() Non-API

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.measure.UnitConverter

isIdentity, isLinear

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

IDENTITY

public static final AbstractConverter IDENTITY

Holds identity converter.

conversionSteps

protected List<? extends javax.measure.UnitConverter> conversionSteps

memoization for getConversionSteps

Constructor Detail

AbstractConverter

protected AbstractConverter()

DefaultQuantityFactory constructor.

Method Detail

of

public static javax.measure.UnitConverter of(javax.measure.Prefix prefix)

Creates a converter with the specified Prefix.

Parameters:

prefix - the prefix for the factor.

equals

public abstract boolean equals(Object cvtr)

Overrides:

equals in class Object

hashCode

public abstract int hashCode()

Overrides:

hashCode in class Object

transformationLiteral

protected abstract String 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.

Returns:

toString

public final String toString()

Overrides:

toString in class Object

inverseWhenNotIdentity

protected abstract 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.

Returns:

inverse

public final AbstractConverter inverse()

Specified by:

inverse in interface javax.measure.UnitConverter

isSimpleCompositionWith

protected abstract boolean isSimpleCompositionWith(AbstractConverter that)

Non-API Guard for simpleCompose(AbstractConverter)

Parameters:

that -

Returns:

whether or not a 'simple' composition of transformations is possible

simpleCompose

protected AbstractConverter simpleCompose(AbstractConverter that)

Non-API Guarded by isSimpleCompositionWith(AbstractConverter)

Parameters:

that -

Returns:

a new AbstractConverter that adds no additional conversion step

concatenate

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

Specified by:

concatenate in interface javax.measure.UnitConverter

getConversionSteps

public final List<? extends javax.measure.UnitConverter> getConversionSteps()

Specified by:

getConversionSteps in interface javax.measure.UnitConverter

convertWhenNotIdentity

protected abstract double convertWhenNotIdentity(double value)

Non-API

Parameters:

value -

Returns:

transformed value

convertWhenNotIdentity

protected Number convertWhenNotIdentity(BigInteger value,
                                        MathContext ctx)

Non-API

Parameters:

value -

ctx -

Returns:

transformed value (most likely a BigInteger or BigDecimal)

convertWhenNotIdentity

protected abstract BigDecimal convertWhenNotIdentity(BigDecimal value,
                                                     MathContext ctx)

Non-API

Parameters:

value -

ctx -

Returns:

transformed value

convert

public final double convert(double value)

Specified by:

convert in interface javax.measure.UnitConverter

convert

public final Number convert(Number value)

Specified by:

convert in interface javax.measure.UnitConverter

Specified by:

convert in interface tech.uom.lib.common.function.Converter<Number,Number>

Throws:

IllegalArgumentException - if the value is null.