|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Messages
Interface for i18n message retrieval through a ResourceBundle
and abbreviated formatting using String.format(java.util.Locale, String, Object...)
.
Additionally, this interface supports mapping to plural forms
using a given PluralRule
.
Method Summary | |
---|---|
String |
formatPluralString(double n,
String key,
Object... args)
Format the given localized message with possible plural forms with a set of arguments. |
String |
formatString(String key,
Object... args)
Format the given localized message with a set of arguments. |
Locale |
getLocale()
|
PluralRule |
getPluralRule()
|
String |
getPluralString(double n,
String key)
Find a localized message with possible plural forms. |
String |
getString(String key)
|
Method Detail |
---|
Locale getLocale()
PluralRule getPluralRule()
String getString(String key)
key
- The key to search for in the message catalog.
NullPointerException
- if key
is null
MissingResourceException
- if no object for the given key can be found
ClassCastException
- if the object found for the given key is not a stringString formatString(String key, Object... args)
String.format(i18n.getLocale(),i18n.getString(key),args)
key
- The key to search for in the message catalog.args
- The argument to the format string.
NullPointerException
- if key
is null
MissingResourceException
- if no object for the given key can be found
ClassCastException
- if the object found for the given key is not a stringString getPluralString(double n, String key)
<key>.<tag>
, if the associated PluralRule
return a non-null plural tag like one
or zero
.
If a message for these special keys is not found or
the plural rule return NullPointerException
, the unmodified key
is used to fetch the message.
n
- The plural denominator.key
- The key to search for in the message catalog.
NullPointerException
- if key
is null
MissingResourceException
- if no object for the given key can be found
ClassCastException
- if the object found for the given key is not a stringString formatPluralString(double n, String key, Object... args)
String.format(i18n.getLocale(),i18n.getPluralString(n,key),args)
n
- The plural denominator.key
- The key to search for in the message catalog.args
- The argument to the format string.
NullPointerException
- if key
is null
MissingResourceException
- if no object for the given key can be found
ClassCastException
- if the object found for the given key is not a string
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |