Interface I18nHelper

All Known Implementing Classes:
I18nHelperImpl

public interface I18nHelper
Gets text messages that allow for i18n.
  • Method Details

    • getText

      String getText(String key)
      Parameters:
      key - i18n key.
      Returns:
      internationalised text.
    • getText

      String getText(String key, String value1)
      Parameters:
      key - i18n key.
      value1 - first value to interpolate.
      Returns:
      internationalised text.
    • getText

      String getText(String key, String value1, String value2)
      Parameters:
      key - i18n key.
      value1 - first value to interpolate.
      value2 - second value to interpolate.
      Returns:
      internationalised text.
    • getText

      String getText(String key, Object parameters)
      Parameters:
      key - i18n key.
      parameters - list, object array or value of parameter(s) to interpolate.
      Returns:
      internationalised text.
    • getUnescapedText

      String getUnescapedText(String key)
      Parameters:
      key - i18n key.
      Returns:
      unescaped internationalised text.
    • getUnescapedText

      String getUnescapedText(Locale locale, String key)
      Parameters:
      locale - the locale to translate into.
      key - i18n key.
      Returns:
      unescaped internationalised text.
    • getAllTranslationsForPrefix

      Map<String,String> getAllTranslationsForPrefix(String prefix)
      Return a map of all the translated keys whose keys start with the given prefix, indexed by their key.
      Parameters:
      prefix - the prefix
      Returns:
      a Map of keys to translated keys
      Throws:
      NullPointerException - if prefix is null
    • getText

      String getText(Locale locale, String key, Serializable... arguments)
      Parameters:
      locale - the locale to translate into.
      key - the key to translate.
      arguments - the arguments to be inserted into the translated string.
      Returns:
      the translated string.