com.liferay.portal.kernel.util
Class LocalizationUtil
java.lang.Object
com.liferay.portal.kernel.util.LocalizationUtil
- Direct Known Subclasses:
- LocalizationUtil
public class LocalizationUtil
- extends Object
This class is used to localize values stored in XML and is often used to add
localization behavior to value objects.
Caching of the localized values is done in this class rather than in the
value object since value objects get flushed from cache fairly quickly.
Though lookups performed on a key based on an XML file is slower than lookups
done at the value object level in general, the value object will get flushed
at a rate which works against the performance gain. The cache is a soft hash
map which prevents memory leaks within the system while enabling the cache to
live longer than in a weak hash map.
Method Summary |
static Object |
deserialize(JSONObject jsonObject)
|
static String[] |
getAvailableLocales(String xml)
|
static String |
getDefaultLocale(String xml)
|
static Localization |
getLocalization()
|
static String |
getLocalization(String xml,
String requestedLanguageId)
|
static String |
getLocalization(String xml,
String requestedLanguageId,
boolean useDefault)
|
static Map<Locale,String> |
getLocalizationMap(PortletRequest portletRequest,
String parameter)
|
static Map<Locale,String> |
getLocalizationMap(String xml)
|
static String |
getLocalizationXmlFromPreferences(PortletPreferences preferences,
PortletRequest portletRequest,
String parameter)
|
static Map<Locale,String> |
getLocalizedParameter(PortletRequest portletRequest,
String parameter)
Deprecated. Use getLocalizationMap . |
static String |
getPreferencesValue(PortletPreferences preferences,
String key,
String languageId)
|
static String |
getPreferencesValue(PortletPreferences preferences,
String key,
String languageId,
boolean useDefault)
|
static String[] |
getPreferencesValues(PortletPreferences preferences,
String key,
String languageId)
|
static String[] |
getPreferencesValues(PortletPreferences preferences,
String key,
String languageId,
boolean useDefault)
|
static String |
removeLocalization(String xml,
String key,
String requestedLanguageId)
|
static String |
removeLocalization(String xml,
String key,
String requestedLanguageId,
boolean cdata)
|
void |
setLocalization(Localization localization)
|
static void |
setLocalizedPreferencesValues(PortletRequest portletRequest,
PortletPreferences preferences,
String parameter)
|
static void |
setPreferencesValue(PortletPreferences preferences,
String key,
String languageId,
String value)
|
static void |
setPreferencesValues(PortletPreferences preferences,
String key,
String languageId,
String[] values)
|
static String |
updateLocalization(String xml,
String key,
String value)
|
static String |
updateLocalization(String xml,
String key,
String value,
String requestedLanguageId)
|
static String |
updateLocalization(String xml,
String key,
String value,
String requestedLanguageId,
String defaultLanguageId)
|
static String |
updateLocalization(String xml,
String key,
String value,
String requestedLanguageId,
String defaultLanguageId,
boolean cdata)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
LocalizationUtil
public LocalizationUtil()
deserialize
public static Object deserialize(JSONObject jsonObject)
getAvailableLocales
public static String[] getAvailableLocales(String xml)
getDefaultLocale
public static String getDefaultLocale(String xml)
getLocalization
public static Localization getLocalization()
getLocalization
public static String getLocalization(String xml,
String requestedLanguageId)
getLocalization
public static String getLocalization(String xml,
String requestedLanguageId,
boolean useDefault)
getLocalizationMap
public static Map<Locale,String> getLocalizationMap(PortletRequest portletRequest,
String parameter)
getLocalizationMap
public static Map<Locale,String> getLocalizationMap(String xml)
getLocalizationXmlFromPreferences
public static String getLocalizationXmlFromPreferences(PortletPreferences preferences,
PortletRequest portletRequest,
String parameter)
getLocalizedParameter
public static Map<Locale,String> getLocalizedParameter(PortletRequest portletRequest,
String parameter)
- Deprecated. Use
getLocalizationMap
.
getPreferencesValue
public static String getPreferencesValue(PortletPreferences preferences,
String key,
String languageId)
getPreferencesValue
public static String getPreferencesValue(PortletPreferences preferences,
String key,
String languageId,
boolean useDefault)
getPreferencesValues
public static String[] getPreferencesValues(PortletPreferences preferences,
String key,
String languageId)
getPreferencesValues
public static String[] getPreferencesValues(PortletPreferences preferences,
String key,
String languageId,
boolean useDefault)
removeLocalization
public static String removeLocalization(String xml,
String key,
String requestedLanguageId)
removeLocalization
public static String removeLocalization(String xml,
String key,
String requestedLanguageId,
boolean cdata)
setLocalizedPreferencesValues
public static void setLocalizedPreferencesValues(PortletRequest portletRequest,
PortletPreferences preferences,
String parameter)
throws Exception
- Throws:
Exception
setPreferencesValue
public static void setPreferencesValue(PortletPreferences preferences,
String key,
String languageId,
String value)
throws Exception
- Throws:
Exception
setPreferencesValues
public static void setPreferencesValues(PortletPreferences preferences,
String key,
String languageId,
String[] values)
throws Exception
- Throws:
Exception
updateLocalization
public static String updateLocalization(String xml,
String key,
String value)
updateLocalization
public static String updateLocalization(String xml,
String key,
String value,
String requestedLanguageId)
updateLocalization
public static String updateLocalization(String xml,
String key,
String value,
String requestedLanguageId,
String defaultLanguageId)
updateLocalization
public static String updateLocalization(String xml,
String key,
String value,
String requestedLanguageId,
String defaultLanguageId,
boolean cdata)
setLocalization
public void setLocalization(Localization localization)