FileDocCategorySizeDatePackage
FormatterImpl.javaAPI DocphoneME MR2 API (J2ME)11204Wed May 02 18:00:46 BST 2007com.sun.j2me.global

FormatterImpl

public class FormatterImpl extends Object implements CommonFormatter
This class actually realizes most of the methods of {@link javax.microedition.global.Formatter}. Specifically, these are:
  • {@link #formatDateTime(Calendar, int)}
  • {@link #formatCurrency(double)}
  • {@link #formatCurrency(double, String)}
  • {@link #formatNumber(double)}
  • {@link #formatNumber(double, int)}
  • {@link #formatNumber(long)}
  • {@link #formatPercentage(long number)}
  • {@link #formatPercentage(float, int)}

This realization of Formatter is intended to be based on some native functions for formatting support. Regarding this, FormatterImpl uses locale index that points to its locale instead of working with explicit locale code.

Fields Summary
private int
locale_index
Current FormatterImpl locale index in the list of supported locales.
Constructors Summary
public FormatterImpl(String locale)
Constructs a Formatter implementation for the specified locale.

param
locale desired FormatterImpl locale
throws
UnsupportedLocaleException The exception is thrown when locale isn't supported.

		locale_index = FormatAbstractionLayerImpl.getFormatLocaleIndex(locale);
		if (locale_index < 0) {
			throw new UnsupportedLocaleException("Locale \""
												 + locale +
												 "\" unsupported.");
		}
Methods Summary
public java.lang.StringformatCurrency(double number)
Formats a currency amount using locale-specific rules. This method assumes that the amount is in the locale's currency. The result uses the locale-specific decimal separator and may include grouping separators. The number of decimals is also locale-specific.

This method does not perform any currency conversions based on exchange rates. x

param
number the currency amount to format
return
the formatted currency amount

        return formatCurrency(number, null);
public java.lang.StringformatCurrency(double number, java.lang.String currencyCode)
Formats a currency amount using the locale-specific rules but using the symbol of the specified currency. The currency is specified using its ISO 4217 three-letter code, such as "USD", "EUR" or "GBP". If there is a currency symbol attached to the ISO 4217 code in the implementation, that symbol MUST be used instead of the locale's currency symbol. If the implementation does not provide a currency symbol for a given ISO 4217 code, the code MUST be used as such.

The result uses the locale-specific decimal separator and may include grouping separators. The number of decimals is also locale-specific.

This method does not perform any currency conversions based on exchange rates.

param
number the currency amount to format
param
currencyCode the ISO 4217 currency code to use
return
formatted currency amount

        if (Double.isNaN(number) || Double.isInfinite(number)) {
            return new Double(number).toString();
        }
        return formatCurrency0(locale_index, number, currencyCode);
private native java.lang.StringformatCurrency0(int locale, double number, java.lang.String currency)

public java.lang.StringformatDateTime(java.util.Calendar dateTime, int style)
Formats a date/time instance using locale-specific rules.
The style parameter determines the extent and style
of the result. 

If dateTime has an associated
java.util.TimeZone
object, dateTime MUST be interpreted as "wall time", not
universal time. The offset of that time zone MUST be reflected in the
formatted time.
param
dateTime the date and time to format
param
style the formatting style to use
return
the date and/or time formatted as a string
            return formatDateTime0(locale_index,
                                   dateTime.get(Calendar.YEAR), 
                                   dateTime.get(Calendar.MONTH) + 1, 
                                   dateTime.get(Calendar.DAY_OF_WEEK),
                                   dateTime.get(Calendar.DAY_OF_MONTH),
                                   dateTime.get(Calendar.HOUR_OF_DAY),
                                   dateTime.get(Calendar.MINUTE),
                                   dateTime.get(Calendar.SECOND),
                                   style);
    
private native java.lang.StringformatDateTime0(int locale, int year, int month, int dayOfWeek, int day, int hour, int minute, int secs, int style)
public java.lang.StringformatNumber(double number)
Formats a decimal number using locale-specific rules. The result
includes a locale-specific decimal separator and may include grouping
separators. 


The symbols used for negative and positive infinity and NaN are
implementation-specific. Implementations MAY use the appropriate Unicode
character (U+221F INFINITY) if applicable.
param
number the number to format
return
formatted decimal number
        if (Double.isNaN(number) || Double.isInfinite(number)) {
            return new Double(number).toString();
        }
        return formatNumber0(locale_index, number, -1);
    
public java.lang.StringformatNumber(double number, int decimals)
Formats a decimal number using locale-specific rules, with the specified
number of decimals. The result includes a locale-specific decimal
separator and may include grouping separators. 


The number of decimals MUST be between 1 and 15. The formatted result
MUST have exactly the specified number of decimals, even if some of the
trailing digits are zeroes. 


The symbols used for negative and positive infinity and NaN are
implementation-specific. Implementations MAY use the appropriate Unicode
character (U+221F INFINITY) if applicable.
param
number the number to format
param
decimals number of decimals
return
formatted decimal number
		if (decimals<=0 || decimals>15){
			throw new IllegalArgumentException("Wrong decimals parameter");
		}
        if (Double.isNaN(number) || Double.isInfinite(number)) {
            return new Double(number).toString();
        }
        return formatNumber0(locale_index, number, decimals);
    
public java.lang.StringformatNumber(long number)
Formats an integer using locale-specific rules. The result may include
grouping separators.
param
number the number to format
return
formatted integer number
        return formatNumber1(locale_index, number);
    
private native java.lang.StringformatNumber0(int locale, double number, int decimals)
private native java.lang.StringformatNumber1(int locale, long number)
public java.lang.StringformatPercentage(long number)
Formats an integral percentage value using locale-specific rules. This
method places the locale-specific percent sign at the correct position
in relation to the number, with the appropriate number of space
(possibly none) between the sign and the number. 


A percentage is expressed as an integer value. Negative percentages are
allowed.
param
number the number to format
return
formatted percentage number
        return formatPercentage1(locale_index, number);
    
public java.lang.StringformatPercentage(float number, int decimals)
Formats a percentage with the specified number of decimals using
locale-specific rules. This method places the locale-specific percent
sign at the correct position in relation to the number, with the
appropriate amount of space (possibly none) between the sign and the
number. 


A percentage is expressed as a decimal number, with the value 0.0
interpreted as 0% and the value 1.0 as 100%. Percentages larger than
100% are expressed as values greater than 1.0. Negative percentages are
allowed, and expressed as values smaller than 0.0. The percentage is
rounded to the specified number of decimals. 


The number of decimals MUST be between 1 and 15. The formatted result
MUST have exactly the specified number of decimals, even if some of the
trailing digits are zeroes.
param
number the percentage to format, expressed as a positive or
negative number
param
decimals the number of decimals to use (1 <= decimals <=
15)
return
formatted percentage string
		if (decimals<=0 || decimals>15){
			throw new IllegalArgumentException("Wrong decimals parameter");
		}
        if (Float.isNaN(number) || Float.isInfinite(number)) {
            return new Float(number).toString();
        }
        return formatPercentage0(locale_index, number, decimals);
    
private native java.lang.StringformatPercentage0(int locale_index, float number, int decimals)
private native java.lang.StringformatPercentage1(int locale_index, long number)