oracle.apps.fnd.applcore.i18n.text
Class FormatUtil

java.lang.Object
  oracle.apps.fnd.applcore.i18n.text.FormatUtil

public class FormatUtil
extends java.lang.Object

This class provides the static APIs for date, datetime, time and number formatting.

Constructor Summary

protected

FormatUtil() Constructor.

Method Summary

static java.lang.String	formatCurrency(java.lang.Number currencyAmount, java.lang.String currencyCode) Returns formatted currency string from Number value based on the currency specified and user preferences.
static java.lang.String	formatCurrencyWithCode(java.lang.Number currencyAmount, java.lang.String currencyCode) Returns formatted currency string with code from Number value based on the currency specified and user preferences.
static java.lang.String	formatCurrencyWithSymbol(java.lang.Number currencyAmount, java.lang.String currencyCode) Returns formatted currency string with symbol from Number value based on the currency specified and user preferences.
static java.lang.String	formatDate(java.util.Date date) Returns formatted date string based on the user preferences.
static java.lang.String	formatDateCanonical(java.util.Date date) Returns canonical formatted date string.
static java.lang.String	formatDateTime(java.util.Date datetime) Returns formatted datetime string based on the user preferences.
static java.lang.String	formatDateTime(java.util.Date datetime, java.util.TimeZone timezone) Returns formatted datetime string based on the user preferences.
static java.lang.String	formatDateTimeCanonical(java.util.Date datetime) Returns canonical formatted date string.
static java.lang.String	formatNumber(java.lang.Number numericValue) Returns formatted string from Number value based on user preferences.
static java.lang.String	formatNumber(java.lang.Number numericValue, int maxFractionDigits) Returns formatted string from Number value with the specified maxiumn fraction digit and user preferences.
static java.lang.String	formatNumber(java.lang.Number numericValue, java.lang.String pattern) Returns formatted string from Number value with the specified format pattern and user preferences.
static java.lang.String	formatNumber(java.lang.Number numericValue, java.lang.String pattern, int maxFractionDigits) Returns formatted string from Number value with the specified format pattern, maxiumn fraction digit and user preferences.
static java.lang.String	formatNumberCanonical(java.lang.Number numericValue) Returns canonical formatted string from Number.
static java.lang.String	formatTime(java.util.Date time) Returns formatted time string based on the user preferences.
static java.lang.String	formatTime(java.util.Date time, java.util.TimeZone timezone) Returns formatted time string based on the user preferences.
static java.lang.String	getCurrencyFormat(java.lang.String currencyCode) Returns currency format without symbol or code.
static java.lang.String	getCurrencyFormat(java.lang.String currencyCode, int precision) Returns currency format mask without symbol or code.
static NumberFormatter	getCurrencyFormatterInstance(ApplSession session, java.lang.String currencyCode) Returns NumberFormatter instance for currency number.
static NumberFormatter	getCurrencyFormatterWithCodeInstance(ApplSession session, java.lang.String currencyCode) Returns NumberFormatter instance for currency number with currency code.
static NumberFormatter	getCurrencyFormatterWithSymbolInstance(ApplSession session, java.lang.String currencyCode) Returns NumberFormatter instance for currency number with currency symbol.
static java.lang.String	getCurrencyFormatWithCode(java.lang.String currencyCode) Returns currency format mask with currency code.
static java.lang.String	getCurrencyFormatWithCode(java.lang.String currencyCode, int precision) Returns currency format mask with currency code based on the precision specified.
static java.lang.String	getCurrencyFormatWithSymbol(java.lang.String currencyCode) Returns currency format mask with symbol.
static java.lang.String	getCurrencyFormatWithSymbol(java.lang.String currencyCode, int precision) Returns currency format mask with symbol based on the precision specified.
static java.lang.String	getCurrencyFormatWithSymbol(java.lang.String currencyCode, int precision, java.lang.String currencySymbol) Returns currency format mask with symbol based on the precision and symbol specified.
static DateFormatter	getDateFormatterInstance(ApplSession session) Returns DateFormatter instance for date formatting and parsing.
static DateFormatter	getDateTimeFormatterInstance(ApplSession session) Returns DateTimeFormatter instance for date/time formatting and parsing.
static DateFormatter	getDateTimeFormatterInstance(ApplSession session, java.util.TimeZone timezone) Returns DateFormatter instance with the timezone given for date/time formatting and parsing.
static I18NContext	getI18NContext(ApplSession session) Returns I18NContext.
static NumberFormatter	getNumberFormatterInstance(ApplSession session) Returns NumberFormatter instance.
static NumberFormatter	getNumberFormatterInstance(ApplSession session, java.lang.String formatMask, java.lang.String parseMask) Returns NumberFormatter instance.
static int	getPrecision(java.lang.String currencyCode) Returns precision number based on the currency code specified.
static java.lang.String[]	getProfileValue() Retruns profile value of CURRENCY:POSITIVE_FORMAT and CURRENCY:NEGATIVE_FORMAT
static DateFormatter	getTimeFormatterInstance(ApplSession session) Returns TimeFormatter instance for time formatting.
static DateFormatter	getTimeFormatterInstance(ApplSession session, java.util.TimeZone timezone) Returns TimeFormatter instance with the timezone given for time formatting.
static java.util.Date	parseDateCanonical(java.lang.String text) Returns Date object from a text given.
static java.util.Date	parseDateTimeCanonical(java.lang.String text) Returns java.util.Date object from a String given.
static java.lang.Number	parseNumberCanonical(java.lang.String text) Returns Number parsed from String in the canonical format.

Methods inherited from class java.lang.Object

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

Constructor Detail

FormatUtil

protected FormatUtil()

Constructor.

Method Detail

formatDate

public static java.lang.String formatDate(java.util.Date date)

Returns formatted date string based on the user preferences.

Parameters:

date - Date, date to be formatted.

Returns:

String, formatted date

formatDateTime

public static java.lang.String formatDateTime(java.util.Date datetime)

Returns formatted datetime string based on the user preferences.

Parameters:

datetime - Date, datetime to be formatted.

Returns:

String, formatted date

formatDateTime

public static java.lang.String formatDateTime(java.util.Date datetime,
                                              java.util.TimeZone timezone)

Returns formatted datetime string based on the user preferences.

Parameters:

datetime - Date, datetime to be formatted.

timezone - TimeZone, timezone used.

Returns:

String, formatted date

formatTime

public static java.lang.String formatTime(java.util.Date time)

Returns formatted time string based on the user preferences.

Parameters:

time - Date, time to be formatted.

Returns:

String, formatted date

formatTime

public static java.lang.String formatTime(java.util.Date time,
                                          java.util.TimeZone timezone)

Returns formatted time string based on the user preferences.

Parameters:

time - Date, time to be formatted.

timezone - TimeZone, timezone used.

Returns:

String, formatted date

formatNumber

public static java.lang.String formatNumber(java.lang.Number numericValue)

Returns formatted string from Number value based on user preferences.

Parameters:

numericValue - Number, numeric value to be formatted.

Returns:

String, formatted number.

formatNumber

public static java.lang.String formatNumber(java.lang.Number numericValue,
                                            java.lang.String pattern)

Returns formatted string from Number value with the specified format pattern and user preferences.

Parameters:

numericValue - Number, numeric value to be formatted.

pattern - String, pattern in Java style.

Returns:

String, formatted number.

formatNumber

public static java.lang.String formatNumber(java.lang.Number numericValue,
                                            java.lang.String pattern,
                                            int maxFractionDigits)

Returns formatted string from Number value with the specified format pattern, maxiumn fraction digit and user preferences.

Parameters:

numericValue - Number, numeric value to be formatted.

pattern - String, pattern in Java style.

maxFractionDigits - int, the maximum number of fraction digits to be shown; if less than zero, then zero is used.

Returns:

String, formatted number.

formatNumber

public static java.lang.String formatNumber(java.lang.Number numericValue,
                                            int maxFractionDigits)

Returns formatted string from Number value with the specified maxiumn fraction digit and user preferences.

Parameters:

numericValue - Number, numeric value to be formatted.

maxFractionDigits - int, the maximum number of fraction digits to be shown; if less than zero, then zero is used.

Returns:

String, formatted number.

formatCurrency

public static java.lang.String formatCurrency(java.lang.Number currencyAmount,
                                              java.lang.String currencyCode)

Returns formatted currency string from Number value based on the currency specified and user preferences.

Parameters:

currencyAmount - Number, numeric value to be formatted.

currencyCode - String, currency code (ISO 4217 based)

Returns:

String, formatted currency number.

formatCurrencyWithSymbol

public static java.lang.String formatCurrencyWithSymbol(java.lang.Number currencyAmount,
                                                        java.lang.String currencyCode)

Returns formatted currency string with symbol from Number value based on the currency specified and user preferences.

Parameters:

currencyAmount - Number, numeric value to be formatted.

currencyCode - String, currency code (ISO 4217 based)

Returns:

String, formatted currency number.

formatCurrencyWithCode

public static java.lang.String formatCurrencyWithCode(java.lang.Number currencyAmount,
                                                      java.lang.String currencyCode)

Returns formatted currency string with code from Number value based on the currency specified and user preferences.

Parameters:

currencyAmount - Number, numeric value to be formatted.

currencyCode - String, currency code (ISO 4217 based)

Returns:

String, formatted currency number.

formatDateCanonical

public static java.lang.String formatDateCanonical(java.util.Date date)

Returns canonical formatted date string.

Parameters:

date - Date, to be formatted.

Returns:

String, canonical formatted date.

Format mask is yyyy-MM-dd (ISO-8601: http://www.w3.org/TR/NOTE-datetime). E.g.2003-10-12.

parseDateCanonical

public static java.util.Date parseDateCanonical(java.lang.String text)

Returns Date object from a text given. If the given string cannot be parsed as a date, null is returned.

Parameters:

text - String to be parsed.

Returns:

Date, parsed from the text.

The format needs to be yyyy-MM-dd (ISO-8601: http://www.w3.org/TR/NOTE-datetime), and the text to be parsed is for example 2003-10-12. If the given string cannot be parsed as a date, null is returned.

formatDateTimeCanonical

public static java.lang.String formatDateTimeCanonical(java.util.Date datetime)

Returns canonical formatted date string. The time zone for the time is always UTC.

Parameters:

datetime - Date, to be formatted.

Returns:

String, canonical formatted datetime. Format mask is yyyy-MM-dd'T'HH:mm:ss.SSS'Z' (ISO-8601: http://www.w3.org/TR/NOTE-datetime). E.g.2003-10-12T18:36:24.579Z.

parseDateTimeCanonical

public static java.util.Date parseDateTimeCanonical(java.lang.String text)

Returns java.util.Date object from a String given. If the given string cannot be parsed as a date, null is returned.

Parameters:

text - String to be parsed.

Returns:

Date, parsed from the text. The format needs to be yyyy-MM-dd'T'HH:mm:ss.SSS'Z' (ISO-8601: http://www.w3.org/TR/NOTE-datetime), and the text to be parsed is for example 2003-10-12T18:36:24.579Z, and its time zone has to be UTC. If the given string cannot be parsed as a date, null is returned.

formatNumberCanonical

public static java.lang.String formatNumberCanonical(java.lang.Number numericValue)

Returns canonical formatted string from Number.

Parameters:

numericValue - Number, numeric value to be formatted.

Returns:

String, formatted number.

Format mask is ######.###, and "." (dot) is always used as a decimal separator. E.g.123.45

parseNumberCanonical

public static java.lang.Number parseNumberCanonical(java.lang.String text)

Returns Number parsed from String in the canonical format. If the given string cannot be parsed as a date, null is returned.

Parameters:

text - String, to be parsed.

Returns:

Number, parsed.

Format mask is ######.###, and "." (dot) is always used as a decimal separator. E.g.123.45

getDateFormatterInstance

public static DateFormatter getDateFormatterInstance(ApplSession session)

Returns DateFormatter instance for date formatting and parsing.

Parameters:

session - ApplSession

Returns:

DateFormatter

getDateTimeFormatterInstance

public static DateFormatter getDateTimeFormatterInstance(ApplSession session)

Returns DateTimeFormatter instance for date/time formatting and parsing.

Parameters:

session - ApplSession

Returns:

DateFormatter

getDateTimeFormatterInstance

public static DateFormatter getDateTimeFormatterInstance(ApplSession session,
                                                         java.util.TimeZone timezone)

Returns DateFormatter instance with the timezone given for date/time formatting and parsing.

Parameters:

session - ApplSession

timezone - TimeZone

Returns:

DateFormatter

getTimeFormatterInstance

public static DateFormatter getTimeFormatterInstance(ApplSession session)

Returns TimeFormatter instance for time formatting.

Parameters:

session - ApplSession

Returns:

DateFormatter

getTimeFormatterInstance

public static DateFormatter getTimeFormatterInstance(ApplSession session,
                                                     java.util.TimeZone timezone)

Returns TimeFormatter instance with the timezone given for time formatting.

Parameters:

session - ApplSession

timezone - TimeZone

Returns:

DateFormatter

getNumberFormatterInstance

public static NumberFormatter getNumberFormatterInstance(ApplSession session)

Returns NumberFormatter instance.

Parameters:

session - ApplSession

Returns:

NumberFormatter

getNumberFormatterInstance

public static NumberFormatter getNumberFormatterInstance(ApplSession session,
                                                         java.lang.String formatMask,
                                                         java.lang.String parseMask)

Returns NumberFormatter instance.

Parameters:

session - ApplSession

formatMask - String, java format mask for formatting.

parseMask - String, java format mask for parsing.

Returns:

NumberFormatter

getCurrencyFormatterInstance

public static NumberFormatter getCurrencyFormatterInstance(ApplSession session,
                                                           java.lang.String currencyCode)

Returns NumberFormatter instance for currency number.

Parameters:

session - ApplSession

currencyCode - String

Returns:

NumberFormatter

getCurrencyFormatterWithSymbolInstance

public static NumberFormatter getCurrencyFormatterWithSymbolInstance(ApplSession session,
                                                                     java.lang.String currencyCode)

Returns NumberFormatter instance for currency number with currency symbol.

Parameters:

session - ApplSession

currencyCode - String

Returns:

NumberFormatter

getCurrencyFormatterWithCodeInstance

public static NumberFormatter getCurrencyFormatterWithCodeInstance(ApplSession session,
                                                                   java.lang.String currencyCode)

Returns NumberFormatter instance for currency number with currency code.

Parameters:

session - ApplSession

currencyCode - String

Returns:

NumberFormatter

getI18NContext

public static I18NContext getI18NContext(ApplSession session)

Returns I18NContext.

Parameters:

session - ApplSession

Returns:

I18NContext

getCurrencyFormat

public static java.lang.String getCurrencyFormat(java.lang.String currencyCode)

Returns currency format without symbol or code.

Parameters:

currencyCode - String, currency code

Returns:

String

getCurrencyFormat

public static java.lang.String getCurrencyFormat(java.lang.String currencyCode,
                                                 int precision)

Returns currency format mask without symbol or code.

Parameters:

currencyCode - String, currency code

precision - , precision number

Returns:

String

getCurrencyFormatWithSymbol

public static java.lang.String getCurrencyFormatWithSymbol(java.lang.String currencyCode)

Returns currency format mask with symbol.

Parameters:

currencyCode - String, currency code

Returns:

String

getCurrencyFormatWithSymbol

public static java.lang.String getCurrencyFormatWithSymbol(java.lang.String currencyCode,
                                                           int precision)

Returns currency format mask with symbol based on the precision specified.

Parameters:

currencyCode - String, currency code

precision - , precision number

Returns:

String

getCurrencyFormatWithSymbol

public static java.lang.String getCurrencyFormatWithSymbol(java.lang.String currencyCode,
                                                           int precision,
                                                           java.lang.String currencySymbol)

Returns currency format mask with symbol based on the precision and symbol specified.

Parameters:

currencyCode - String, currency code

precision - , precision number

currencySymbol - String, currency symbol.

Returns:

String

getCurrencyFormatWithCode

public static java.lang.String getCurrencyFormatWithCode(java.lang.String currencyCode)

Returns currency format mask with currency code.

Parameters:

currencyCode - String, currency code

Returns:

String

getCurrencyFormatWithCode

public static java.lang.String getCurrencyFormatWithCode(java.lang.String currencyCode,
                                                         int precision)

Returns currency format mask with currency code based on the precision specified.

Parameters:

currencyCode - String, currency code

precision - , precision number

Returns:

String

getPrecision

public static int getPrecision(java.lang.String currencyCode)

Returns precision number based on the currency code specified. If there is no data defined for the currency, 2 is returnd.

Parameters:

currencyCode -

Returns:

getProfileValue

public static java.lang.String[] getProfileValue()

Retruns profile value of CURRENCY:POSITIVE_FORMAT and CURRENCY:NEGATIVE_FORMAT

Returns:

String[]