public class NoopI18nHelper extends Object implements I18nHelper
I18nHelper that returns the i18n key concatenated with its arguments.
This can be used in tests to ensure correct i18n messages are returned. The makeTranslation(String, java.util.List)
method can be used to create an expected value of a test.I18nHelper.BeanFactory| Constructor and Description |
|---|
NoopI18nHelper() |
NoopI18nHelper(Locale locale) |
| Modifier and Type | Method and Description |
|---|---|
ResourceBundle |
getDefaultResourceBundle()
Returns the default
ResourceBundle within JIRA, which does not include translations provided by plugins. |
Set<String> |
getKeysForPrefix(String prefix)
Given a prefix for an i18n key, this method will return all keys that start with the prefix specified.
|
Locale |
getLocale() |
ResourceBundle |
getResourceBundle()
Returns the consolidated ResourceBundle for this I18nHelper, which includes translations provided by plugins.
|
String |
getText(String key)
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
|
String |
getText(String key,
Object params)
Called to return the formatted text of the specified i18n key or the key itself if no message can be found.
|
String |
getText(String key,
Object value1,
Object value2,
Object value3)
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
|
String |
getText(String key,
Object value1,
Object value2,
Object value3,
Object value4)
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
|
String |
getText(String key,
Object value1,
Object value2,
Object value3,
Object value4,
Object value5)
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
|
String |
getText(String key,
Object value1,
Object value2,
Object value3,
Object value4,
Object value5,
Object value6)
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
|
String |
getText(String key,
Object value1,
Object value2,
Object value3,
Object value4,
Object value5,
Object value6,
Object value7)
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
|
String |
getText(String key,
Object value1,
Object value2,
Object value3,
Object value4,
Object value5,
Object value6,
Object value7,
Object value8)
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
|
String |
getText(String key,
String value1)
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
|
String |
getText(String key,
String value1,
String value2)
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
|
String |
getText(String key,
String value1,
String value2,
String value3)
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
|
String |
getText(String key,
String value1,
String value2,
String value3,
String value4)
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
|
String |
getText(String key,
String value1,
String value2,
String value3,
String value4,
String value5,
String value6,
String value7)
Called to return the formatted text of the specified i18n key
|
String |
getText(String key,
String value1,
String value2,
String value3,
String value4,
String value5,
String value6,
String value7,
String value8,
String value9)
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
|
String |
getUnescapedText(String key)
Called to return the un-formatted text of the specified i18n key or the key itself if no message can be found
|
String |
getUntransformedRawText(String key)
Same as
I18nHelper.getUnescapedText(String) but does not apply any TranslationTransforms. |
boolean |
isKeyDefined(String key)
For the given key, checks whether such a key is defined in the locale context represented by this helper
instance.
|
static String |
makeTranslation(String key,
List<?> arguments) |
static String |
makeTranslation(String key,
Object... arguments) |
public NoopI18nHelper()
public NoopI18nHelper(Locale locale)
public String getText(String key)
I18nHelpergetText in interface I18nHelperkey - the key of the i18n messagepublic Locale getLocale()
getLocale in interface I18nHelperLocale that is associated with this I18nHelperpublic String getUnescapedText(String key)
I18nHelpergetUnescapedText in interface I18nHelperkey - the key of the i18n messagepublic String getUntransformedRawText(String key)
I18nHelperI18nHelper.getUnescapedText(String) but does not apply any TranslationTransforms.getUntransformedRawText in interface I18nHelperkey - the key of the i18n messagepublic boolean isKeyDefined(String key)
I18nHelperI18nHelper.getUntransformedRawText(String), whereby if this
method returns false, I18nHelper.getUntransformedRawText(String) will return the key provided as an
argument, and if this method returns true, I18nHelper.getUntransformedRawText(String) will generally
return the translation, which in some very unlikely cases may be equal to the key.isKeyDefined in interface I18nHelperkey - translation keytrue, if any translation for such key exists, false otherwisepublic String getText(String key, String value1)
I18nHelpergetText in interface I18nHelperkey - the key of the i18n messagevalue1 - a value to be substituted into the messagepublic String getText(String key, Object value1, Object value2, Object value3)
I18nHelpergetText in interface I18nHelperkey - the key of the i18n messagevalue1 - a value to be substituted into the messagevalue2 - a value to be substituted into the messagevalue3 - a value to be substituted into the messagepublic String getText(String key, Object value1, Object value2, Object value3, Object value4)
I18nHelpergetText in interface I18nHelperkey - the key of the i18n messagevalue1 - a value to be substituted into the messagevalue2 - a value to be substituted into the messagevalue3 - a value to be substituted into the messagevalue4 - a value to be substituted into the messagepublic String getText(String key, Object value1, Object value2, Object value3, Object value4, Object value5)
I18nHelpergetText in interface I18nHelperkey - the key of the i18n messagevalue1 - a value to be substituted into the messagevalue2 - a value to be substituted into the messagevalue3 - a value to be substituted into the messagevalue4 - a value to be substituted into the messagevalue5 - a value to be substituted into the messagepublic String getText(String key, Object value1, Object value2, Object value3, Object value4, Object value5, Object value6, Object value7)
I18nHelpergetText in interface I18nHelperkey - the key of the i18n messagevalue1 - a value to be substituted into the messagevalue2 - a value to be substituted into the messagevalue3 - a value to be substituted into the messagevalue4 - a value to be substituted into the messagevalue5 - a value to be substituted into the messagevalue6 - a value to be substituted into the messagevalue7 - a value to be substituted into the messagepublic String getText(String key, Object value1, Object value2, Object value3, Object value4, Object value5, Object value6, Object value7, Object value8)
I18nHelpergetText in interface I18nHelperkey - the key of the i18n messagevalue1 - a value to be substituted into the messagevalue2 - a value to be substituted into the messagevalue3 - a value to be substituted into the messagevalue4 - a value to be substituted into the messagevalue5 - a value to be substituted into the messagevalue6 - a value to be substituted into the messagevalue7 - a value to be substituted into the messagevalue8 - a value to be substituted into the messagepublic String getText(String key, String value1, String value2)
I18nHelpergetText in interface I18nHelperkey - the key of the i18n messagevalue1 - a value to be substituted into the messagevalue2 - a value to be substituted into the messagepublic String getText(String key, String value1, String value2, String value3)
I18nHelpergetText in interface I18nHelperkey - the key of the i18n messagevalue1 - a value to be substituted into the messagevalue2 - a value to be substituted into the messagevalue3 - a value to be substituted into the messagepublic String getText(String key, String value1, String value2, String value3, String value4)
I18nHelpergetText in interface I18nHelperkey - the key of the i18n messagevalue1 - a value to be substituted into the messagevalue2 - a value to be substituted into the messagevalue3 - a value to be substituted into the messagevalue4 - a value to be substituted into the messagepublic String getText(String key, Object value1, Object value2, Object value3, Object value4, Object value5, Object value6)
I18nHelpergetText in interface I18nHelperkey - the key of the i18n messagevalue1 - a value to be substituted into the messagevalue2 - a value to be substituted into the messagevalue3 - a value to be substituted into the messagevalue4 - a value to be substituted into the messagevalue5 - a value to be substituted into the messagevalue6 - a value to be substituted into the messagepublic String getText(String key, String value1, String value2, String value3, String value4, String value5, String value6, String value7)
I18nHelpergetText in interface I18nHelperkey - the key of the i18n messagevalue1 - a value to be substituted into the messagevalue2 - a value to be substituted into the messagevalue3 - a value to be substituted into the messagevalue4 - a value to be substituted into the messagevalue5 - a value to be substituted into the messagevalue6 - a value to be substituted into the messagevalue7 - a value to be substituted into the messagepublic String getText(String key, String value1, String value2, String value3, String value4, String value5, String value6, String value7, String value8, String value9)
I18nHelpergetText in interface I18nHelperkey - the key of the i18n messagevalue1 - a value to be substituted into the messagevalue2 - a value to be substituted into the messagevalue3 - a value to be substituted into the messagevalue4 - a value to be substituted into the messagevalue5 - a value to be substituted into the messagevalue6 - a value to be substituted into the messagevalue7 - a value to be substituted into the messagevalue8 - a value to be substituted into the messagevalue9 - a value to be substituted into the messagepublic ResourceBundle getDefaultResourceBundle()
I18nHelperResourceBundle within JIRA, which does not include translations provided by plugins.
For use cases where non-English translations are required, call I18nHelper.getResourceBundle() instead.getDefaultResourceBundle in interface I18nHelperI18nHelper.getResourceBundle()public String getText(String key, Object params)
I18nHelperList} or a single parameter object. It will be then
used as substitution parameters within the message.getText in interface I18nHelperkey - the key of the i18n messageparams - This can be an Array, a List and Array or a single object parameterpublic Set<String> getKeysForPrefix(String prefix)
I18nHelpergetKeysForPrefix in interface I18nHelperprefix - The prefix for i18n keys. May not be nullpublic ResourceBundle getResourceBundle()
I18nHelpergetResourceBundle in interface I18nHelperI18nHelper.getDefaultResourceBundle()Copyright © 2002-2016 Atlassian. All Rights Reserved.