javax.measure.converter
Class AddConverter

java.lang.Object
  javax.measure.converter.UnitConverter
      javax.measure.converter.AddConverter

All Implemented Interfaces:

java.io.Serializable

public final class AddConverter
extends UnitConverter

This class represents a converter adding a constant offset to numeric values (double based).

Instances of this class are immutable.

Version:

1.0, April 15, 2009

Author:

Jean-Marie Dautelle

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.measure.converter.UnitConverter

IDENTITY

Constructor Summary

AddConverter(double offset)
Creates an add converter with the specified offset.

Method Summary

UnitConverter	concatenate(UnitConverter converter) Concatenates this converter with another converter.
java.math.BigDecimal	convert(java.math.BigDecimal value, java.math.MathContext ctx) Converts a BigDecimal value.
double	convert(double value) Converts a double value.
boolean	equals(java.lang.Object obj) Indicates whether this converter is considered to be the the same as the one specified.
double	getOffset() Returns the offset value for this add converter.
int	hashCode() Returns a hash code value for this converter.
AddConverter	inverse() Returns the inverse of this converter.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AddConverter

public AddConverter(double offset)

Creates an add converter with the specified offset.

Parameters:

offset - the offset value.

Throws:

java.lang.IllegalArgumentException - if offset is 0.0 (would result in identity converter).

Method Detail

getOffset

public double getOffset()

Returns the offset value for this add converter.

Returns:

the offset value.

concatenate

public UnitConverter concatenate(UnitConverter converter)

Description copied from class: UnitConverter

Concatenates this converter with another converter. The resulting converter is equivalent to first converting by the specified converter, and then converting by this converter.

Note: Implementations must ensure that the UnitConverter.IDENTITY instance is returned if the resulting converter is an identity converter.

Overrides:

concatenate in class UnitConverter

Parameters:

converter - the other converter.

Returns:

the concatenation of this converter with the other converter.

inverse

public AddConverter inverse()

Description copied from class: UnitConverter

Returns the inverse of this converter. If x is a valid value, then x == inverse().convert(convert(x)) to within the accuracy of computer arithmetic.

Specified by:

inverse in class UnitConverter

Returns:

the inverse of this converter.

convert

public double convert(double value)

Description copied from class: UnitConverter

Converts a double value.

Specified by:

convert in class UnitConverter

Parameters:

value - the numeric value to convert.

Returns:

the double value after conversion.

convert

public java.math.BigDecimal convert(java.math.BigDecimal value,
                                    java.math.MathContext ctx)
                             throws java.lang.ArithmeticException

Description copied from class: UnitConverter

Converts a BigDecimal value.

Specified by:

convert in class UnitConverter

Parameters:

value - the numeric value to convert.

ctx - the math context being used for conversion.

Returns:

the decimal value after conversion.

Throws:

java.lang.ArithmeticException - if the result is inexact but the rounding mode is MathContext.UNNECESSARY or mathContext.precision == 0 and the quotient has a non-terminating decimal expansion.

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Description copied from class: UnitConverter

Indicates whether this converter is considered to be the the same as the one specified.

Specified by:

equals in class UnitConverter

Parameters:

obj - the converter with which to compare.

Returns:

true if the specified object is a converter considered equals to this converter;false otherwise.

hashCode

public int hashCode()

Description copied from class: UnitConverter

Returns a hash code value for this converter. Equals object have equal hash codes.

Specified by:

hashCode in class UnitConverter

Returns:

this converter hash code value.

See Also:

UnitConverter.equals(java.lang.Object)