tech.units.indriya.function

Class PowerOfPiConverter

java.lang.Object

tech.units.indriya.AbstractConverter

tech.units.indriya.function.PowerOfPiConverter

All Implemented Interfaces:

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

public final class PowerOfPiConverter
extends AbstractConverter
implements tech.uom.lib.common.function.IntExponentSupplier

This class represents a converter multiplying numeric values by a factor of Pi to the power of an integer exponent (π^exponent).

Since:

2.0

Version:

1.1, May 10, 2018

Author:

Andi Huber, Werner Keil

See Also:

Serialized Form

Nested Class Summary

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

AbstractConverter.Pair

Field Summary

Fields inherited from class tech.units.indriya.AbstractConverter

conversionSteps, IDENTITY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PowerOfPiConverter(int exponent)

Method Summary

Modifier and Type	Method and Description
int	compareTo(javax.measure.UnitConverter o)
BigDecimal	convertWhenNotIdentity(BigDecimal value, MathContext ctx) Non-API
double	convertWhenNotIdentity(double value) Non-API
boolean	equals(Object obj)
int	getExponent()
int	hashCode()
AbstractConverter	inverseWhenNotIdentity() Non-API
boolean	isIdentity()
boolean	isLinear()
protected boolean	isSimpleCompositionWith(AbstractConverter that) Non-API Guard for AbstractConverter.simpleCompose(AbstractConverter)
static PowerOfPiConverter	of(int exponent) Creates a converter with the specified exponent.
protected AbstractConverter	simpleCompose(AbstractConverter that) Non-API Guarded by AbstractConverter.isSimpleCompositionWith(AbstractConverter)
String	transformationLiteral() Non-API

Methods inherited from class tech.units.indriya.AbstractConverter

concatenate, convert, convert, convertWhenNotIdentity, getConversionSteps, inverse, of, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

PowerOfPiConverter

protected PowerOfPiConverter(int exponent)

Method Detail

of

public static PowerOfPiConverter of(int exponent)

Creates a converter with the specified exponent.

Parameters:

exponent - the exponent for the factor π^exponent.

getExponent

public int getExponent()

Specified by:

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

isIdentity

public boolean isIdentity()

Specified by:

isIdentity in interface javax.measure.UnitConverter

isLinear

public boolean isLinear()

Specified by:

isLinear in interface javax.measure.UnitConverter

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

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

Description copied from class: AbstractConverter

Non-API

Specified by:

convertWhenNotIdentity in class AbstractConverter

Returns:

transformed value

Throws:

ArithmeticException

convertWhenNotIdentity

public double convertWhenNotIdentity(double value)

Description copied from class: AbstractConverter

Non-API

Specified by:

convertWhenNotIdentity in class AbstractConverter

Returns:

transformed value

isSimpleCompositionWith

protected boolean isSimpleCompositionWith(AbstractConverter that)

Description copied from class: AbstractConverter

Non-API Guard for AbstractConverter.simpleCompose(AbstractConverter)

Specified by:

isSimpleCompositionWith in class AbstractConverter

Returns:

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

simpleCompose

protected AbstractConverter simpleCompose(AbstractConverter that)

Description copied from class: AbstractConverter

Non-API Guarded by AbstractConverter.isSimpleCompositionWith(AbstractConverter)

Overrides:

simpleCompose in class AbstractConverter

Returns:

a new AbstractConverter that adds no additional conversion step

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:

compareTo

public int compareTo(javax.measure.UnitConverter o)

Specified by:

compareTo in interface Comparable<javax.measure.UnitConverter>

hashCode

public int hashCode()

Specified by:

hashCode in class AbstractConverter