net.pandoragames.util.i18n

Interface Localizer

All Known Implementing Classes:

BundleLocalizer, DefaultLocalizer, DummyLocalizer, LocalizerBase

public interface Localizer

This interface describes how to bundle standard support for the locale sensitive rendering of Java objects and application internal message codes in the form of human readable text, brief, for "localization".

Author:

Olivier Wehner

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getLanguage() Returns the ISO language code of the java.util.Locale object currently used for rendering
java.util.Locale	getLocale() Returns the java.util.Locale object that is currently used for formatting
java.lang.String	localize(java.util.Date date, java.lang.String patternCode) Returns a String representing the specified Date object using the format pattern that is represented by the specified code.
java.lang.String	localize(double number, int digits) Renders the specified double value with exactly the number of specified digits and according to the rulse imposed by the currently used Locale object of this Localizer instance.
java.lang.String	localize(long number) Returns a String representing the specified long value and rendered for the currently used Locale of this Localizer instance.
java.lang.String	localize(java.lang.String code) Returns some locale specific, human readable text for the specified code, or the code unchanged if no such translation could be done,
java.lang.String	localize(java.lang.String code, java.lang.Object replacementValue) Returns some locale specific, human readable text for the specified code, filled with the specified replacement value using java.text.MessageFormat syntax.
java.lang.String	localize(java.lang.String code, java.lang.Object[] replacementValues) Returns some locale specific, human readable text for the specified code, filled with the specified replacement values using java.text.MessageFormat syntax.
java.util.Date	parseDate(java.lang.String date, java.lang.String patternCode) Returns the java.util.Date object that is represented by the specified String.
java.lang.Double	parseDouble(java.lang.String doubleNumber) Returns the double value that is represented by the specified String, or throws a ParseException if parsing fails.
java.lang.Integer	parseInt(java.lang.String integerNumber) Returns the int value that is represented by the specified String, or throws a ParseException if parsing fails.
java.lang.Long	parseLong(java.lang.String longNumber) Returns the long value that is represented by the specified String, or throws a ParseException if parsing fails.

Method Detail

getLocale

java.util.Locale getLocale()

Returns the java.util.Locale object that is currently used for formatting

Returns:

currently used Locale

getLanguage

java.lang.String getLanguage()

Returns the ISO language code of the java.util.Locale object currently used for rendering

Returns:

ISO language code

localize

java.lang.String localize(java.lang.String code)

Returns some locale specific, human readable text for the specified code, or the code unchanged if no such translation could be done,

Parameters:

code - application internal code for some text

Returns:

human readable text (or supplied code)

localize

java.lang.String localize(java.lang.String code,
                        java.lang.Object replacementValue)

Returns some locale specific, human readable text for the specified code, filled with the specified replacement value using java.text.MessageFormat syntax. This is a convinience shortcut for the multi object localize() method.

Parameters:

code - application internal code for some text

replacementValue - object that shall be filled into the place holder of the resulting text.

Returns:

human readable text (or null)

See Also:

localize(String, Object[])

localize

java.lang.String localize(java.lang.String code,
                        java.lang.Object[] replacementValues)

Returns some locale specific, human readable text for the specified code, filled with the specified replacement values using java.text.MessageFormat syntax.

Parameters:

code - application internal code for some text

replacementValues - objects that shall be filled into the place holder of the resulting text.

Returns:

human readable text (or null)

See Also:

MessageFormat

localize

java.lang.String localize(long number)

Returns a String representing the specified long value and rendered for the currently used Locale of this Localizer instance.

Parameters:

number - value to be rendered.

Returns:

locale specific representation of the specified long value

localize

java.lang.String localize(double number,
                        int digits)

Renders the specified double value with exactly the number of specified digits and according to the rulse imposed by the currently used Locale object of this Localizer instance.

Parameters:

number - value to be rendered.

Returns:

locale specific representation of the specified double value with the indicated number of digits

localize

java.lang.String localize(java.util.Date date,
                        java.lang.String patternCode)

Returns a String representing the specified Date object using the format pattern that is represented by the specified code. The patterCode argument is not directly used as a date pattern, it rather represents a date patern in the Locale of this instance.

Parameters:

date - date to be rendered.

patternCode - refering a special date pattern

Returns:

locale specific representation of the specified Date object

parseInt

java.lang.Integer parseInt(java.lang.String integerNumber)

Returns the int value that is represented by the specified String, or throws a ParseException if parsing fails.

Parameters:

integerNumber - String that represents an integer value

Returns:

integer value represented by the specified String, or null if the String could not be parsed

parseLong

java.lang.Long parseLong(java.lang.String longNumber)

Returns the long value that is represented by the specified String, or throws a ParseException if parsing fails.

Parameters:

longNumber - String that represents a long value

Returns:

long value represented by the specified String, or null if the String could not be parsed

parseDouble

java.lang.Double parseDouble(java.lang.String doubleNumber)

Returns the double value that is represented by the specified String, or throws a ParseException if parsing fails.

Parameters:

doubleNumber - String that represents a double value

Returns:

double value represented by the specified String, or null if the String could not be parsed

parseDate

java.util.Date parseDate(java.lang.String date,
                       java.lang.String patternCode)

Returns the java.util.Date object that is represented by the specified String. The patterCode argument is not directly used as a date pattern, it rather represents a date patern in the Locale of this instance.

Parameters:

date - String that represents a date

patternCode - refering a special date pattern

Returns:

java.util.Date object represented by the specified String, or null if the String could not be parsed