org.seedstack.i18n

Interface LocalizationService

@Service
public interface LocalizationService

This service provides common localization features according to a specified locale.

Author:

adrien.lauer@mpsa.com, yves.dautremay@mpsa.com

Method Summary

Modifier and Type	Method and Description
String	formatCurrencyAmount(String locale, Number amount) Format the specified amount in the locale currency.
String	formatCurrencyAmount(String locale, Number amount, String currency) Format the specified amount in the specified locale and currency.
String	formatDate(String locale, Date date, String skeleton) Format a date using the specified locale.
String	formatDate(String locale, Date date, String skeleton, String timezone) Format a date using the specified locale and the specified timezone.
String	formatNumber(String locale, Number number) Format a number according to the specified locale.
String	localize(String locale, String key) Return a localized string based on the specified locale and key.
String	localize(String locale, String key, Object... args) Return a localized string based on the specified locale and key.
Number	parseCurrencyAmount(String locale, String value) Parse the specified amount in the locale default currency.
Number	parseCurrencyAmount(String locale, String value, String currency) Parse the specified amount in the specified locale and currency.
Date	parseDate(String locale, String value, String skeleton) Parse a date using the specified locale.
Date	parseDate(String locale, String value, String skeleton, String timezone) Parse a date using the specified locale and the specified timezone.
Number	parseNumber(String locale, String value) Parse a number according to the specified locale.

Method Detail

localize

String localize(String locale,
                String key)

Return a localized string based on the specified locale and key. If the translation is not found in the given locale, the method reach parent locales (eg. "fr-BE" then "fr"). If no translation is found "[" + key + "]" is returned.

Parameters:

locale - The locale identifier.

key - The i18n key to translate.

Returns:

The translation result.

localize

String localize(String locale,
                String key,
                Object... args)

Return a localized string based on the specified locale and key. The pattern is formatted according to the given arguments

Parameters:

locale - The locale identifier.

key - The i18n key to translate.

args - The arguments used for message formatting.

Returns:

The translation result.

See Also:

localize(String, String)

formatDate

String formatDate(String locale,
                  Date date,
                  String skeleton)

Format a date using the specified locale.

Parameters:

locale - The locale identifier.

date - The date to format.

skeleton - The pattern elements that will be included in the formatted string.

Returns:

The formatted date as a string.

formatDate

String formatDate(String locale,
                  Date date,
                  String skeleton,
                  String timezone)

Format a date using the specified locale and the specified timezone.

Parameters:

locale - The locale identifier.

date - The date to format.

skeleton - The pattern elements that will be included in the formatted string.

timezone - The timezone identifier.

Returns:

The formatted date as a string.

parseDate

Date parseDate(String locale,
               String value,
               String skeleton)
        throws ParseException

Parse a date using the specified locale.

Parameters:

locale - The locale identifier.

value - The string to parse.

skeleton - The pattern elements used to parse the string.

Returns:

The parsed date object.

Throws:

ParseException - if the given string cannot be parsed into a Date

parseDate

Date parseDate(String locale,
               String value,
               String skeleton,
               String timezone)
        throws ParseException

Parse a date using the specified locale and the specified timezone.

Parameters:

locale - The locale identifier.

value - The string to parse.

skeleton - The pattern elements used to parse the string.

timezone - The timezone identifier.

Returns:

The parsed date object.

Throws:

ParseException - if the given string cannot be parsed into a Date

formatCurrencyAmount

String formatCurrencyAmount(String locale,
                            Number amount)

Format the specified amount in the locale currency.

Parameters:

locale - The locale identifier.

amount - The amount to format.

Returns:

The formatted string.

formatCurrencyAmount

String formatCurrencyAmount(String locale,
                            Number amount,
                            String currency)

Format the specified amount in the specified locale and currency.

Parameters:

locale - The locale identifier.

amount - The amount to format.

currency - The currency identifier as a 3-letter ISO4217 code.

Returns:

The formatted string.

parseCurrencyAmount

Number parseCurrencyAmount(String locale,
                           String value)
                    throws ParseException

Parse the specified amount in the locale default currency.

Parameters:

locale - The locale identifier.

value - The value to parse.

Returns:

The formatted string.

Throws:

ParseException - if the given value cannot be parsed into an amount

parseCurrencyAmount

Number parseCurrencyAmount(String locale,
                           String value,
                           String currency)
                    throws ParseException

Parse the specified amount in the specified locale and currency.

Parameters:

locale - The locale identifier.

value - The value to parse.

currency - The currency identifier.

Returns:

The formatted string.

Throws:

ParseException - if the given value cannot be parsed into an amount

formatNumber

String formatNumber(String locale,
                    Number number)

Format a number according to the specified locale.

Parameters:

locale - The locale identifier.

number - The number to format.

Returns:

The formatted string.

parseNumber

Number parseNumber(String locale,
                   String value)
            throws ParseException

Parse a number according to the specified locale.

Parameters:

locale - The locale identifier.

value - The string to parse.

Returns:

The parsed number.

Throws:

ParseException - if the given value cannot be parsed into a number