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 (approximated as a double) to numeric values.

Instances of this class are immutable.

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.measure.converter.UnitConverter

IDENTITY

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
UnitConverter	concatenate(UnitConverter converter) Concatenates this converter with another converter.
double	convert(double amount) Converts a double value.
double	getOffset() Returns the offset value for this add converter.
UnitConverter	inverse() Returns the inverse of this converter.
boolean	isLinear() Indicates if this converter is linear.

Methods inherited from class javax.measure.converter.UnitConverter

equals, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, 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 zero (or close to zero).

Method Detail

getOffset

public double getOffset()

Returns the offset value for this add converter.

Returns:

the offset value.

inverse

public UnitConverter 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 amount)

Description copied from class: UnitConverter

Converts a double value.

Specified by:

convert in class UnitConverter

Parameters:

amount - the numeric value to convert.

Returns:

the converted numeric value.

isLinear

public boolean isLinear()

Description copied from class: UnitConverter

Indicates if this converter is linear. A converter is linear if convert(u + v) == convert(u) + convert(v) and convert(r * u) == r * convert(u). For linear converters the following property always hold:[code] y1 = c1.convert(x1); y2 = c2.convert(x2); then y1*y2 = c1.concatenate(c2).convert(x1*x2)[/code]

Specified by:

isLinear in class UnitConverter

Returns:

true if this converter is linear; false otherwise.

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.