Package tech.units.indriya.function

Class PowerOfIntConverter

java.lang.Object

tech.units.indriya.function.AbstractConverter

tech.units.indriya.function.PowerOfIntConverter

All Implemented Interfaces:

Serializable, Comparable<UnitConverter>, DoubleSupplier, UnitConverter, MultiplyConverter, tech.uom.lib.common.function.Converter<Number,Number>, tech.uom.lib.common.function.FactorSupplier<Number>, tech.uom.lib.common.function.IntBaseSupplier, tech.uom.lib.common.function.IntExponentSupplier, tech.uom.lib.common.function.ValueSupplier<Number>

public final class PowerOfIntConverter
extends AbstractConverter
implements MultiplyConverter, tech.uom.lib.common.function.IntBaseSupplier, tech.uom.lib.common.function.IntExponentSupplier

UnitConverter for numbers in base^exponent representation.

Since:

2.0

Version:

2.0, Oct 8, 2020

Author:

Andi Huber, Werner Keil

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class tech.units.indriya.function.AbstractConverter

AbstractConverter.Pair

Field Summary

Fields inherited from class tech.units.indriya.function.AbstractConverter

conversionSteps, IDENTITY, UNIT_COMPOSITION_HANDLER

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PowerOfIntConverter(int base, int exponent)

Method Summary

Modifier and Type	Method	Description
protected boolean	canReduceWith(AbstractConverter that)	Non-API Guard for AbstractConverter.reduce(AbstractConverter)
int	compareTo(UnitConverter o)
protected Number	convertWhenNotIdentity(Number value)	Non-API
boolean	equals(Object obj)
double	getAsDouble()
int	getBase()
int	getExponent()
Number	getValue()
int	hashCode()
AbstractConverter	inverseWhenNotIdentity()	Non-API
boolean	isIdentity()
protected AbstractConverter	reduce(AbstractConverter that)	Non-API Guarded by AbstractConverter.canReduceWith(AbstractConverter)
RationalConverter	toRationalConverter()
String	transformationLiteral()	Non-API

Methods inherited from class tech.units.indriya.function.AbstractConverter

concatenate, convert, convert, getConversionSteps, inverse, linearFactor, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface tech.uom.lib.common.function.Converter

convert

Methods inherited from interface tech.units.indriya.function.MultiplyConverter

getFactor, isLinear

Methods inherited from interface javax.measure.UnitConverter

concatenate, convert, convert, getConversionSteps, inverse

Constructor Detail

PowerOfIntConverter

protected PowerOfIntConverter(int base,
                              int exponent)

Method Detail

getBase

public int getBase()

Specified by:

getBase in interface tech.uom.lib.common.function.IntBaseSupplier

getExponent

public int getExponent()

Specified by:

getExponent in interface tech.uom.lib.common.function.IntExponentSupplier

isIdentity

public boolean isIdentity()

Specified by:

isIdentity in interface UnitConverter

canReduceWith

protected boolean canReduceWith(AbstractConverter that)

Description copied from class: AbstractConverter

Non-API Guard for AbstractConverter.reduce(AbstractConverter)

Specified by:

canReduceWith in class AbstractConverter

Returns:

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

reduce

protected AbstractConverter reduce(AbstractConverter that)

Description copied from class: AbstractConverter

Non-API Guarded by AbstractConverter.canReduceWith(AbstractConverter)

Overrides:

reduce in class AbstractConverter

Returns:

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

inverseWhenNotIdentity

public AbstractConverter 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

protected Number convertWhenNotIdentity(Number value)

Description copied from class: AbstractConverter

Non-API

Specified by:

convertWhenNotIdentity in class AbstractConverter

Returns:

transformed value

equals

public boolean equals(Object obj)

Specified by:

equals in class AbstractConverter

transformationLiteral

public final 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:

getValue

public Number getValue()

Specified by:

getValue in interface tech.uom.lib.common.function.ValueSupplier<Number>

getAsDouble

public double getAsDouble()

Specified by:

getAsDouble in interface DoubleSupplier

compareTo

public int compareTo(UnitConverter o)

Specified by:

compareTo in interface Comparable<UnitConverter>

hashCode

public int hashCode()

Specified by:

hashCode in class AbstractConverter

toRationalConverter

public RationalConverter toRationalConverter()