ariba.util.formatter
Class DoubleFormatter

java.lang.Object
  ariba.util.formatter.Formatter
      ariba.util.formatter.DecimalFormatterCommon
          ariba.util.formatter.DoubleFormatter

All Implemented Interfaces:

Compare, StringParser

public class DoubleFormatter
extends DecimalFormatterCommon

DoubleFormatter is a subclass of Formatter which is responsible for formatting, parsing, and comparing double values and/or Double objects.

Field Summary

static String

ClassName Our Java class name.

Fields inherited from interface ariba.util.core.Compare

EqualTo, GreaterThan, LessThan

Constructor Summary

DoubleFormatter()
Creates a new DoubleFormatter.

Method Summary

static int	compareDoubles(double d1, double d2) Compares two double values for sorting purposes.
static int	compareDoubles(Double d1, Double d2) Compares two Double objects for sorting purposes.
static Double	flexibleDoubleValue(Object stringValue) Flexible conversion of a string into a Double.
String	formatObject(Object object, int precision, Locale locale) Returns a string representation of the given object in the given locale with the given precision.
static double	getDoubleValue(Object object) Returns a double value derived from the given object in the default locale.
static double	getDoubleValue(Object object, Locale locale) Returns a double value derived from the given object in the default locale.
static String	getStringValue(double value) Returns a formatted string for the given double in the default locale.
static String	getStringValue(Double object) Returns a formatted string for the given Double in the default locale.
static String	getStringValue(double value, int precision) Returns a formatted string for the given double in the default locale.
static String	getStringValue(Double object, int precision) Returns a formatted string for the given Double in the default locale.
static String	getStringValue(double value, int minPrecision, int maxPrecision) Returns a formatted string for the given double in the default locale.
static String	getStringValue(double value, int minPrecision, int maxPrecision, Locale locale) Returns a formatted string for the given double in the given locale.
static String	getStringValue(Double object, int minPrecision, int maxPrecision, Locale locale) Returns a formatted string for the given Double in the given locale.
static String	getStringValue(double value, int minPrecision, int maxPrecision, String pattern, Locale locale) Returns a formatted string for the given double in the given locale.
static String	getStringValue(Double object, int minPrecision, int maxPrecision, String pattern, Locale locale) Returns a formatted string for the given Double in the given locale.
static String	getStringValue(double value, int minPrecision, int maxPrecision, String pattern, Locale locale, boolean trim) Returns a formatted string for the given double in the given locale.
static String	getStringValue(double value, int precision, Locale locale) Returns a formatted string for the given double in the given locale.
static String	getStringValue(Double object, int precision, Locale locale) Returns a formatted string for the given Double in the given locale.
static String	getStringValue(double value, Locale locale) Returns a formatted string for the given double in the given locale.
static String	getStringValue(Double object, Locale locale) Returns a formatted string for the given Double in the given locale.
Object	getValue(Object object, Locale locale) Returns a new Double derived from the given object in the given locale.
static double	parseDouble(String string) Tries to parse the given string as a double in the default locale.
static double	parseDouble(String string, Locale locale) Tries to parse the given string as a double in the given locale.
static double	parseDouble(String string, String pattern, Locale locale) Tries to parse the given string as a double in the given locale.

Methods inherited from class ariba.util.formatter.DecimalFormatterCommon

trimString, trimString

Methods inherited from class ariba.util.formatter.Formatter

canFormatNulls, compare, compare, equal, equal, getFormat, getFormat, getFormatterClassForType, getFormatterForObject, getFormatterForType, getLocale, getStringValue, getStringValue, getValue, handlesNulls, isBidirectional, makeParseException, makeParseException, objectsAreEqual, objectsAreEqual, parse, parse, parseString, parseString, quickCompare, quickCompare, quickCompareValue, registerFormatter

Methods inherited from class java.lang.Object

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

Field Detail

ClassName

public static final String ClassName

Our Java class name.

See Also:

Constant Field Values

Constructor Detail

DoubleFormatter

public DoubleFormatter()

Creates a new DoubleFormatter.

Method Detail

getStringValue

public static String getStringValue(Double object)

Returns a formatted string for the given Double in the default locale. By default, a precision of zero is used.

Parameters:

object - the Double to format into a string

Returns:

a string representation of the Double, or empty string if the Double is null

getStringValue

public static String getStringValue(Double object,
                                    Locale locale)

Returns a formatted string for the given Double in the given locale. By default, a precision of zero is used. The locale parameter must be non-null.

Parameters:

object - the Double to format into a string

locale - the Locale to use for formatting

Returns:

a string representation of the Double, or empty string if the Double is null

getStringValue

public static String getStringValue(Double object,
                                    int precision)

Returns a formatted string for the given Double in the default locale. The precision parameter is used to determine how many fractional digits are shown.

Parameters:

object - the Double to format into a string

precision - the number of fractional digits to show

Returns:

a string representation of the Double, or empty string if the Double is null

getStringValue

public static String getStringValue(Double object,
                                    int precision,
                                    Locale locale)

Returns a formatted string for the given Double in the given locale. The precision parameter is used to determine how many fractional digits are shown. The locale parameter must be non-null.

Parameters:

object - the Double to format into a string

precision - the number of fractional digits to show

locale - the Locale to use for formatting

Returns:

a string representation of the Double, or empty string if the Double is null

getStringValue

public static String getStringValue(Double object,
                                    int minPrecision,
                                    int maxPrecision,
                                    Locale locale)

Returns a formatted string for the given Double in the given locale. The precision parameter is used to determine how many fractional digits are shown. The locale parameter must be non-null.

Parameters:

object - the Double to format into a string

minPrecision - the minimum number of fractional digits to show

maxPrecision - the maximum number of fractional digits to show

locale - the Locale to use for formatting

Returns:

a string representation of the Double, or empty string if the Double is null

getStringValue

public static String getStringValue(Double object,
                                    int minPrecision,
                                    int maxPrecision,
                                    String pattern,
                                    Locale locale)

Returns a formatted string for the given Double in the given locale. The precision parameter is used to determine how many fractional digits are shown. The locale parameter must be non-null.

Parameters:

object - the Double to format into a string

minPrecision - the minimum number of fractional digits to show

maxPrecision - the maximum number of fractional digits to show

pattern - the DecimalFormat pattern to use for formatting

locale - the Locale to use for formatting

Returns:

a string representation of the Double, or empty string if the Double is null

See Also:

DecimalFormat

getStringValue

public static String getStringValue(double value)

Returns a formatted string for the given double in the default locale. By default, a precision of zero is used.

Parameters:

value - the double to format into a string

Returns:

a string representation of the double

getStringValue

public static String getStringValue(double value,
                                    Locale locale)

Returns a formatted string for the given double in the given locale. By default, a precision of zero is used. The locale parameter must be non-null.

Parameters:

value - the double to format into a string

locale - the Locale to use for formatting

Returns:

a string representation of the double

getStringValue

public static String getStringValue(double value,
                                    int precision)

Returns a formatted string for the given double in the default locale. The precision parameter is used to determine how many fractional digits are shown.

Parameters:

value - the double to format into a string

precision - the number of fractional digits to show

Returns:

a string representation of the double

getStringValue

public static String getStringValue(double value,
                                    int precision,
                                    Locale locale)

Returns a formatted string for the given double in the given locale. The precision parameter is used to determine how many fractional digits are shown. The locale parameter must be non-null.

Parameters:

value - the double to format into a string

precision - the number of fractional digits to show

locale - the Locale to use for formatting

Returns:

a string representation of the double

getStringValue

public static String getStringValue(double value,
                                    int minPrecision,
                                    int maxPrecision)

Returns a formatted string for the given double in the default locale.

Parameters:

value - the double to format into a string

minPrecision - the minimum number of fractional digits to show

maxPrecision - the maximum number of fractional digits to show

Returns:

a string representation of the double

getStringValue

public static String getStringValue(double value,
                                    int minPrecision,
                                    int maxPrecision,
                                    Locale locale)

Returns a formatted string for the given double in the given locale.

Parameters:

value - the double to format into a string

minPrecision - the minimum number of fractional digits to show

maxPrecision - the maximum number of fractional digits to show

locale - the Locale to use for formatting

Returns:

a string representation of the double

getStringValue

public static String getStringValue(double value,
                                    int minPrecision,
                                    int maxPrecision,
                                    String pattern,
                                    Locale locale)

Returns a formatted string for the given double in the given locale.

Parameters:

value - the double to format into a string

minPrecision - the minimum number of fractional digits to show

maxPrecision - the maximum number of fractional digits to show

pattern - the DecimalFormat pattern to use for formatting

locale - the Locale to use for formatting

Returns:

a string representation of the double

See Also:

DecimalFormat

getStringValue

public static String getStringValue(double value,
                                    int minPrecision,
                                    int maxPrecision,
                                    String pattern,
                                    Locale locale,
                                    boolean trim)

Returns a formatted string for the given double in the given locale.

Parameters:

value - the double to format into a string

minPrecision - the minimum number of fractional digits to show

maxPrecision - the maximum number of fractional digits to show

pattern - the DecimalFormat pattern to use for formatting

locale - the Locale to use for formatting

trim - true if leading and trailing zeros should be removed.

Returns:

a string representation of the double

See Also:

DecimalFormat

parseDouble

public static double parseDouble(String string)
                          throws ParseException

Tries to parse the given string as a double in the default locale.

Parameters:

string - the string to parse as a double

Returns:

a double value derived from the string

Throws:

ParseException - if the string cannot be parsed as a double

parseDouble

public static double parseDouble(String string,
                                 Locale locale)
                          throws ParseException

Tries to parse the given string as a double in the given locale. The locale parameter must be non-null.

Parameters:

string - the string to parse as a double

locale - the Locale to use for parsing

Returns:

a double value derived from the string

Throws:

ParseException - if the string cannot be parsed as an double

parseDouble

public static double parseDouble(String string,
                                 String pattern,
                                 Locale locale)
                          throws ParseException

Tries to parse the given string as a double in the given locale. The locale parameter must be non-null.

Parameters:

string - the string to parse as a double

pattern - the DecimalFormat pattern to use for parsing

locale - the Locale to use for parsing

Returns:

a double value derived from the string

Throws:

ParseException - if the string cannot be parsed as an double

See Also:

DecimalFormat

getDoubleValue

public static double getDoubleValue(Object object)

Returns a double value derived from the given object in the default locale. If the object is not a Double, it is converted to a string and parsed. Returns 0.0 if the object can't be converted to a double.

Parameters:

object - the object to convert to an double value

Returns:

a double derived from the given object

getDoubleValue

public static double getDoubleValue(Object object,
                                    Locale locale)

Returns a double value derived from the given object in the default locale. If the object is not a Double, it is converted to a string and parsed. Returns 0.0 if the object can't be converted to a double.

Parameters:

object - the object to convert to an double value

locale - the Locale to use for conversion

Returns:

a double derived from the given object

compareDoubles

public static int compareDoubles(Double d1,
                                 Double d2)

Compares two Double objects for sorting purposes. Returns an int value which is less than, equal to, or greater than zero depending on whether the first object sorts before, the same, or after the second object.

Parameters:

d1 - the first Double to compare

d2 - the second Double to compare

Returns:

int value which determines how the two objects should be ordered

compareDoubles

public static int compareDoubles(double d1,
                                 double d2)

Compares two double values for sorting purposes. Returns an int value which is less than, equal to, or greater than zero depending on whether the first value sorts before, the same, or after the second value.

Parameters:

d1 - the first double to compare

d2 - the second double to compare

Returns:

int value which determines how the two values should be ordered

flexibleDoubleValue

public static Double flexibleDoubleValue(Object stringValue)

Flexible conversion of a string into a Double. Converts decimal format, as well as fractional format like "12 3/8 = 12.375" or "1-3/4 = 1.75". Also supports localized format: "12,3/4 = 12.75". If it cannot convert, it returns null.

formatObject

public String formatObject(Object object,
                           int precision,
                           Locale locale)

Returns a string representation of the given object in the given locale with the given precision. The object must be a non-null Double.

Parameters:

object - the Double to format into a string

precision - the number of fractional digits to show

locale - the Locale to use for formatting

Returns:

a string representation of the Double

getValue

public Object getValue(Object object,
                       Locale locale)

Returns a new Double derived from the given object in the given locale. If the object is not a Double, it is converted to a string and parsed. Returns null if the object can't be parsed as a Double.

Specified by:

getValue in class Formatter

Parameters:

object - the object to convert to a Double

locale - the Locale to use for conversion (unused)

Returns:

a Double derived from the given object