org.jscience.physics.amount
Class AmountFormat

java.lang.Object
  javolution.text.TextFormat<Amount<?>>
      org.jscience.physics.amount.AmountFormat

public abstract class AmountFormat
extends TextFormat<Amount<?>>

This class provides the interface for formatting and parsing measures instances. For example:

     // Display measurements using unscaled units (e.g. base units or alternate units).
     AmountFormat.setInstance(new AmountFormat() { // Context local.
         public Appendable format(Amount m, Appendable a) throws IOException {
             Unit u = m.getUnit();
             if (u instanceof TransformedUnit)
                   u = ((TransformedUnit)u).getParentUnit();
             return AmountFormat.getPlusMinusErrorInstance(2).format(m.to(u), a);
         }
         public Amount parse(CharSequence csq, Cursor c) {
             return AmountFormat.getPlusMinusErrorInstance(2).parse(csq, c);
         }
     });

Version:

3.0, February 21, 2006

Author:

Jean-Marie Dautelle

Nested Class Summary

Nested classes/interfaces inherited from class javolution.text.TextFormat

TextFormat.Cursor

Constructor Summary

protected

AmountFormat() Default constructor.

Method Summary

static AmountFormat	getBracketErrorInstance(int digitsInError) Returns a format for which the error is represented by an integer value in brackets; for example "1.3456[20] m" is equivalent to "1.3456 ± 0.0020 m".
static AmountFormat	getExactDigitsInstance() Returns a format for which only digits guaranteed to be exact are written out.
static AmountFormat	getInstance() Returns the current local format (default AmountFormat.getPlusMinusErrorInstance(2)).
static AmountFormat	getPlusMinusErrorInstance(int digitsInError) Returns a format for which the error (if present) is stated using the '±' character; for example "(1.34 ± 0.01) m".
static void	setInstance(AmountFormat format) Sets the current local format.

Methods inherited from class javolution.text.TextFormat

format, format, format, getInstance, parse, parse, setInstance

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AmountFormat

protected AmountFormat()

Default constructor.

Method Detail

getInstance

public static AmountFormat getInstance()

Returns the current local format (default AmountFormat.getPlusMinusErrorInstance(2)).

Returns:

the context local format.

See Also:

getPlusMinusErrorInstance(int)

setInstance

public static void setInstance(AmountFormat format)

Sets the current local format.

Parameters:

format - the new format.

getPlusMinusErrorInstance

public static AmountFormat getPlusMinusErrorInstance(int digitsInError)

Returns a format for which the error (if present) is stated using the '±' character; for example "(1.34 ± 0.01) m". This format can be used for formatting as well as for parsing.

Parameters:

digitsInError - the maximum number of digits in error.

getBracketErrorInstance

public static AmountFormat getBracketErrorInstance(int digitsInError)

Returns a format for which the error is represented by an integer value in brackets; for example "1.3456[20] m" is equivalent to "1.3456 ± 0.0020 m". This format can be used for formatting as well as for parsing.

Parameters:

digitsInError - the maximum number of digits in error.

getExactDigitsInstance

public static AmountFormat getExactDigitsInstance()

Returns a format for which only digits guaranteed to be exact are written out. In other words, the error is always on the last digit and less than the last digit weight. For example, "1.34 m" means a length between 1.32 m and 1.35 m. This format can be used for formatting only.