|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectorg.apache.turbine.services.BaseInitable
org.apache.turbine.services.BaseService
org.apache.turbine.services.TurbineBaseService
org.apache.turbine.services.localization.TurbineLocalizationService
This class is the single point of access to all localization resources. It caches different ResourceBundles for different Locales.
Usage example:
LocalizationService ls = (LocalizationService) TurbineServices
.getInstance().getService(LocalizationService.SERVICE_NAME);
Then call one of four methods to retrieve a ResourceBundle:
| Field Summary |
| Fields inherited from class org.apache.turbine.services.BaseService |
configuration, name, serviceBroker |
| Fields inherited from class org.apache.turbine.services.BaseInitable |
initableBroker, isInitialized |
| Fields inherited from interface org.apache.turbine.services.localization.LocalizationService |
ACCEPT_LANGUAGE, SERVICE_NAME |
| Constructor Summary | |
TurbineLocalizationService()
Constructor. |
|
| Method Summary | |
java.lang.String |
format(java.lang.String bundleName,
java.util.Locale locale,
java.lang.String key,
java.lang.Object arg1)
Formats a localized value using the provided object. |
java.lang.String |
format(java.lang.String bundleName,
java.util.Locale locale,
java.lang.String key,
java.lang.Object[] args)
Looks up the value for key in the
ResourceBundle referenced by
bundleName, then formats that value for the
specified Locale using args. |
java.lang.String |
format(java.lang.String bundleName,
java.util.Locale locale,
java.lang.String key,
java.lang.Object arg1,
java.lang.Object arg2)
Formats a localized value using the provided objects. |
java.util.ResourceBundle |
getBundle()
This method returns a ResourceBundle given the bundle name "DEFAULT" and the default Locale information supplied in TurbineProperties. |
java.util.ResourceBundle |
getBundle(javax.servlet.http.HttpServletRequest req)
This method returns a ResourceBundle given the Locale information supplied in the HTTP "Accept-Language" header which is stored in HttpServletRequest. |
java.util.ResourceBundle |
getBundle(RunData data)
This method returns a ResourceBundle given the Locale information supplied in the HTTP "Accept-Language" header which is stored in RunData. |
java.util.ResourceBundle |
getBundle(java.lang.String bundleName)
This method returns a ResourceBundle given the bundle name and the default Locale information supplied in TurbineProperties. |
java.util.ResourceBundle |
getBundle(java.lang.String bundleName,
javax.servlet.http.HttpServletRequest req)
This method returns a ResourceBundle given the bundle name and the Locale information supplied in the HTTP "Accept-Language" header which is stored in HttpServletRequest. |
java.util.ResourceBundle |
getBundle(java.lang.String bundleName,
java.util.Locale locale)
This method returns a ResourceBundle for the given bundle name and the given Locale. |
java.util.ResourceBundle |
getBundle(java.lang.String bundleName,
RunData data)
This method returns a ResourceBundle given the bundle name and the Locale information supplied in the HTTP "Accept-Language" header which is stored in RunData. |
java.util.ResourceBundle |
getBundle(java.lang.String bundleName,
java.lang.String languageHeader)
This method returns a ResourceBundle given the bundle name and the Locale information supplied in the HTTP "Accept-Language" header. |
java.lang.String[] |
getBundleNames()
Retrieves the list of names of bundles to search by default for ResourceBundle keys (as specified in the config
file). |
java.lang.String |
getDefaultBundleName()
Retrieves the name of the default bundle (as specified in the config file). |
java.lang.String |
getDefaultCountry()
Retrieves the default country (specified in the config file). |
java.lang.String |
getDefaultLanguage()
Retrieves the default language (specified in the config file). |
java.util.Locale |
getLocale(javax.servlet.http.HttpServletRequest req)
Attempts to pull the Accept-Language header out of
the HttpServletRequest object and then parse it.
|
java.util.Locale |
getLocale(java.lang.String header)
This method parses the Accept-Language header and
attempts to create a Locale out of it. |
java.lang.String |
getString(java.lang.String bundleName,
java.util.Locale locale,
java.lang.String key)
Tries very hard to return a value, looking first in the specified bundle, then searching list of default bundles (giving precedence to earlier bundles over later bundles). |
protected java.lang.String |
getStringOrNull(java.util.ResourceBundle rb,
java.lang.String key)
Gets localized text from a bundle if it's there. |
void |
init()
Called the first time the Service is used. |
protected void |
initBundleNames(java.lang.String[] ignored)
Initialize list of default bundle names. |
void |
setBundle(java.lang.String defaultBundle)
This method sets the name of the first bundle in the search list (the "default" bundle). |
| Methods inherited from class org.apache.turbine.services.TurbineBaseService |
init, init, init, shutdown |
| Methods inherited from class org.apache.turbine.services.BaseService |
getConfiguration, getName, getProperties, getServiceBroker, setName, setServiceBroker |
| Methods inherited from class org.apache.turbine.services.BaseInitable |
getInit, getInitableBroker, setInit, setInitableBroker |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface org.apache.turbine.services.Service |
getConfiguration, getName, getProperties, setName, setServiceBroker |
| Methods inherited from interface org.apache.turbine.services.Initable |
getInit, init, setInitableBroker, shutdown |
| Constructor Detail |
public TurbineLocalizationService()
| Method Detail |
public void init()
throws InitializationException
init in interface Initableinit in class TurbineBaseServiceInitializationExceptionprotected void initBundleNames(java.lang.String[] ignored)
ignored - Ignored.public java.lang.String getDefaultLanguage()
getDefaultLanguage in interface LocalizationServicepublic java.lang.String getDefaultCountry()
getDefaultCountry in interface LocalizationServicepublic java.lang.String getDefaultBundleName()
getDefaultBundleName in interface LocalizationServiceLocalizationService.getDefaultBundleName()public java.lang.String[] getBundleNames()
LocalizationServiceResourceBundle keys (as specified in the config
file).
getBundleNames in interface LocalizationServiceLocalizationService.getBundleNames()public java.util.ResourceBundle getBundle()
getBundle in interface LocalizationServicepublic java.util.ResourceBundle getBundle(java.lang.String bundleName)
getBundle in interface LocalizationServicebundleName - Name of bundle.
public java.util.ResourceBundle getBundle(java.lang.String bundleName,
java.lang.String languageHeader)
getBundle in interface LocalizationServicebundleName - Name of bundle.languageHeader - A String with the language header.
public java.util.ResourceBundle getBundle(javax.servlet.http.HttpServletRequest req)
getBundle in interface LocalizationServicereq - HttpServletRequest.
public java.util.ResourceBundle getBundle(java.lang.String bundleName,
javax.servlet.http.HttpServletRequest req)
getBundle in interface LocalizationServicebundleName - Name of the bundle to use if the request's
locale cannot be resolved.req - HttpServletRequest.
public java.util.ResourceBundle getBundle(RunData data)
data - Turbine information.
public java.util.ResourceBundle getBundle(java.lang.String bundleName,
RunData data)
bundleName - Name of bundle.data - Turbine information.
public java.util.ResourceBundle getBundle(java.lang.String bundleName,
java.util.Locale locale)
getBundle in interface LocalizationServicebundleName - Name of bundle (or null for the
default bundle).locale - The locale (or null for the locale
indicated by the default language and country).
public void setBundle(java.lang.String defaultBundle)
setBundle in interface LocalizationServicedefaultBundle - Name of default bundle.public final java.util.Locale getLocale(javax.servlet.http.HttpServletRequest req)
LocalizationServiceAccept-Language header out of
the HttpServletRequest object and then parse it.
If the header is not present, it will return a
null Locale.
getLocale in interface LocalizationServicereq - The HTTP request to parse the
Accept-Language of.
LocalizationService.getLocale(HttpServletRequest)public java.util.Locale getLocale(java.lang.String header)
LocalizationServiceAccept-Language header and
attempts to create a Locale out of it.
getLocale in interface LocalizationServiceheader - The Accept-Language HTTP
header.
LocalizationService.getLocale(String)
public java.lang.String getString(java.lang.String bundleName,
java.util.Locale locale,
java.lang.String key)
LocalizationService
getString in interface LocalizationServicebundleName - Name of the bundle to look in first.locale - Locale to get text for.key - Name of the text to retrieve.
java.util.MissingResourceException - Specified key cannot be matched.LocalizationService.getString(String, Locale, String)
protected final java.lang.String getStringOrNull(java.util.ResourceBundle rb,
java.lang.String key)
null (ignoring a possible
MissingResourceException).
public java.lang.String format(java.lang.String bundleName,
java.util.Locale locale,
java.lang.String key,
java.lang.Object arg1)
format in interface LocalizationServicebundleName - The bundle in which to look for the localizable text.locale - The locale for which to format the text.key - The identifier for the localized text to retrieve,arg1 - The object to use as {0} when formatting the localized text.
format(String, Locale, String, Object[])
public java.lang.String format(java.lang.String bundleName,
java.util.Locale locale,
java.lang.String key,
java.lang.Object arg1,
java.lang.Object arg2)
format in interface LocalizationServicebundleName - The bundle in which to look for the localizable text.locale - The locale for which to format the text.key - The identifier for the localized text to retrieve,arg1 - The object to use as {0} when formatting the localized text.arg2 - The object to use as {1} when formatting the localized text.
format(String, Locale, String, Object[])
public java.lang.String format(java.lang.String bundleName,
java.util.Locale locale,
java.lang.String key,
java.lang.Object[] args)
key in the
ResourceBundle referenced by
bundleName, then formats that value for the
specified Locale using args.
format in interface LocalizationServicebundleName - The bundle in which to look for the localizable text.locale - The locale for which to format the text.key - The identifier for the localized text to retrieve,args - The objects to use when formatting the localized text.
key.
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||