Class AbstractConverter.Pair

java.lang.Object

tech.units.indriya.AbstractConverter

tech.units.indriya.AbstractConverter.Pair

All Implemented Interfaces:

Serializable, Comparable<javax.measure.UnitConverter>, javax.measure.UnitConverter

Enclosing class:

AbstractConverter

public static final class AbstractConverter.Pair
extends AbstractConverter
implements Serializable

This class represents converters made up of two or more separate converters (in matrix notation [pair] = [left] x [right]).

Since:

1.0

Version:

1.6, April 26, 2018

Author:

Jean-Marie Dautelle, Werner Keil, Andi Huber

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class AbstractConverter

AbstractConverter.Pair

Field Summary

Fields inherited from class AbstractConverter

conversionSteps, IDENTITY

Constructor Summary

Constructors

Constructor	Description
Pair(javax.measure.UnitConverter left, javax.measure.UnitConverter right)	Creates a pair converter resulting from the combined transformation of the specified converters.

Method Summary

Modifier and Type	Method	Description
int	compareTo(javax.measure.UnitConverter obj)
double	convertWhenNotIdentity(double value)	Non-API
BigDecimal	convertWhenNotIdentity(BigDecimal value, MathContext ctx)	Non-API
Number	convertWhenNotIdentity(BigInteger value, MathContext ctx)	Non-API
protected List<? extends javax.measure.UnitConverter>	createConversionSteps()
boolean	equals(Object obj)
javax.measure.UnitConverter	getLeft()
javax.measure.UnitConverter	getRight()
int	hashCode()
AbstractConverter.Pair	inverseWhenNotIdentity()	Non-API
boolean	isIdentity()
boolean	isLinear()
protected boolean	isSimpleCompositionWith(AbstractConverter that)	Non-API Guard for AbstractConverter.simpleCompose(AbstractConverter)
protected String	transformationLiteral()	Non-API

Methods inherited from class AbstractConverter

concatenate, convert, convert, getConversionSteps, inverse, of, simpleCompose, toString

Methods inherited from class Object

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

Constructor Details

Pair

public Pair(javax.measure.UnitConverter left,
 javax.measure.UnitConverter right)

Creates a pair converter resulting from the combined transformation of the specified converters.

Parameters:

left - the left converter, not null.

right - the right converter.

Throws:

IllegalArgumentException - if either the left or right converter are null

Method Details

isLinear

public boolean isLinear()

Specified by:

isLinear in interface javax.measure.UnitConverter

isIdentity

public boolean isIdentity()

Specified by:

isIdentity in interface javax.measure.UnitConverter

createConversionSteps

protected List<? extends javax.measure.UnitConverter> createConversionSteps()

inverseWhenNotIdentity

public AbstractConverter.Pair 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:

convertWhenNotIdentity

public double convertWhenNotIdentity(double value)

Description copied from class: AbstractConverter

Non-API

Specified by:

convertWhenNotIdentity in class AbstractConverter

Parameters:

value -

Returns:

transformed value

convertWhenNotIdentity

public Number convertWhenNotIdentity(BigInteger value,
 MathContext ctx)

Description copied from class: AbstractConverter

Non-API

Overrides:

convertWhenNotIdentity in class AbstractConverter

Parameters:

value -

ctx -

Returns:

transformed value (most likely a BigInteger or BigDecimal)

convertWhenNotIdentity

public BigDecimal convertWhenNotIdentity(BigDecimal value,
 MathContext ctx)

Description copied from class: AbstractConverter

Non-API

Specified by:

convertWhenNotIdentity in class AbstractConverter

Parameters:

value -

ctx -

Returns:

transformed value

equals

public boolean equals(Object obj)

Specified by:

equals in class AbstractConverter

hashCode

public int hashCode()

Specified by:

hashCode in class AbstractConverter

getLeft

public javax.measure.UnitConverter getLeft()

getRight

public javax.measure.UnitConverter getRight()

compareTo

public int compareTo(javax.measure.UnitConverter obj)

Specified by:

compareTo in interface Comparable<javax.measure.UnitConverter>

transformationLiteral

protected 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:

isSimpleCompositionWith

protected boolean isSimpleCompositionWith(AbstractConverter that)

Description copied from class: AbstractConverter

Non-API Guard for AbstractConverter.simpleCompose(AbstractConverter)

Specified by:

isSimpleCompositionWith in class AbstractConverter

Parameters:

that -

Returns:

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