java.lang.Object | ||
↳ | webwork.action.ActionSupport | |
↳ | com.atlassian.jira.action.JiraActionSupport |
Known Direct Subclasses |
This class is deprecated.
since 6.1 Please use subclass instead JiraWebActionSupport
. This class is subject of removal.
Clients of @PublicSpi
can expect
that programs compiled against a given version will remain binary compatible with later versions of the
@PublicSpi
as per each product's API policy (clients should refer to each product's API policy for
the exact guarantee -- usually binary compatibility is guaranteed at least across minor versions).
@PublicSpi
interfaces and classes are specifically designed to be implemented/extended by clients.
Hence, the guarantee of binary compatibility is different to that of @PublicApi
elements (if an element
is both @PublicApi
and @PublicSpi
, both guarantees apply).
This class sits just above the base Webwork ActionSupport class and provides JIRA specific code to all our actions.
Its main capabilities are extra error handling and I18n support
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From interface
webwork.action.Action
|
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
log |
[Expand]
Inherited Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
webwork.action.ActionSupport
|
Protected Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Override this method from ActionSupport.
| |||||||||||
Returns the default
ResourceBundle within JIRA, which does not include translations provided by plugins. | |||||||||||
Given a prefix for an i18n key, this method will return all keys that start with the prefix specified.
| |||||||||||
Returns the consolidated ResourceBundle for this I18nHelper, which includes translations provided by plugins.
| |||||||||||
Get a definitive result.
| |||||||||||
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
| |||||||||||
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
| |||||||||||
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
| |||||||||||
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
| |||||||||||
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
| |||||||||||
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
| |||||||||||
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
| |||||||||||
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
| |||||||||||
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
| |||||||||||
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
| |||||||||||
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
| |||||||||||
Called to return the formatted text of the specified i18n key
| |||||||||||
Called to return the formatted text of the specified i18n key or the key itself if no message can be found.
| |||||||||||
Called to return the un-formatted text of the specified i18n key or the key itself if no message can be found
| |||||||||||
Same as
getUnescapedText(String) but does not apply any TranslationTransform s. | |||||||||||
For the given key, checks whether such a key is defined in the locale context represented by this helper instance. |
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
This can be called to get a component from the
ComponentAccessor . | |||||||||||
Checks if descriptorParams contains key and removes it, otherwise adds the error message with the given message
key.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
webwork.action.ActionSupport
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
com.atlassian.jira.util.I18nHelper
| |||||||||||
From interface
webwork.action.Action
| |||||||||||
From interface
webwork.action.CommandDriven
| |||||||||||
From interface
webwork.action.IllegalArgumentAware
|
Override this method from ActionSupport. Body is copied from there, with the exception of a clause that prevents JRA-7245
Returns the default ResourceBundle
within JIRA, which does not include translations provided by plugins.
For use cases where non-English translations are required, call getResourceBundle()
instead.
Given a prefix for an i18n key, this method will return all keys that start with the prefix specified.
prefix | The prefix for i18n keys. May not be null |
---|
Returns the consolidated ResourceBundle for this I18nHelper, which includes translations provided by plugins.
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
key | the key of the i18n message |
---|---|
value1 | a value to be substituted into the message |
value2 | a value to be substituted into the message |
value3 | a value to be substituted into the message |
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
key | the key of the i18n message |
---|---|
value1 | a value to be substituted into the message |
value2 | a value to be substituted into the message |
value3 | a value to be substituted into the message |
value4 | a value to be substituted into the message |
value5 | a value to be substituted into the message |
value6 | a value to be substituted into the message |
value7 | a value to be substituted into the message |
value8 | a value to be substituted into the message |
value9 | a value to be substituted into the message |
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
key | the key of the i18n message |
---|---|
value1 | a value to be substituted into the message |
value2 | a value to be substituted into the message |
value3 | a value to be substituted into the message |
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
key | the key of the i18n message |
---|---|
value1 | a value to be substituted into the message |
value2 | a value to be substituted into the message |
value3 | a value to be substituted into the message |
value4 | a value to be substituted into the message |
value5 | a value to be substituted into the message |
value6 | a value to be substituted into the message |
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
key | the key of the i18n message |
---|---|
value1 | a value to be substituted into the message |
value2 | a value to be substituted into the message |
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
key | the key of the i18n message |
---|---|
value1 | a value to be substituted into the message |
value2 | a value to be substituted into the message |
value3 | a value to be substituted into the message |
value4 | a value to be substituted into the message |
value5 | a value to be substituted into the message |
value6 | a value to be substituted into the message |
value7 | a value to be substituted into the message |
value8 | a value to be substituted into the message |
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
key | the key of the i18n message |
---|---|
value1 | a value to be substituted into the message |
value2 | a value to be substituted into the message |
value3 | a value to be substituted into the message |
value4 | a value to be substituted into the message |
value5 | a value to be substituted into the message |
value6 | a value to be substituted into the message |
value7 | a value to be substituted into the message |
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
key | the key of the i18n message |
---|---|
value1 | a value to be substituted into the message |
value2 | a value to be substituted into the message |
value3 | a value to be substituted into the message |
value4 | a value to be substituted into the message |
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
key | the key of the i18n message |
---|---|
value1 | a value to be substituted into the message |
value2 | a value to be substituted into the message |
value3 | a value to be substituted into the message |
value4 | a value to be substituted into the message |
value5 | a value to be substituted into the message |
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
key | the key of the i18n message |
---|---|
value1 | a value to be substituted into the message |
value2 | a value to be substituted into the message |
value3 | a value to be substituted into the message |
value4 | a value to be substituted into the message |
Called to return the formatted text of the specified i18n key or the key itself if no message can be found
key | the key of the i18n message |
---|---|
value1 | a value to be substituted into the message |
Called to return the formatted text of the specified i18n key
key | the key of the i18n message |
---|---|
value1 | a value to be substituted into the message |
value2 | a value to be substituted into the message |
value3 | a value to be substituted into the message |
value4 | a value to be substituted into the message |
value5 | a value to be substituted into the message |
value6 | a value to be substituted into the message |
value7 | a value to be substituted into the message |
Called to return the formatted text of the specified i18n key or the key itself if no message can be found.
The object passed in can be an array, a List
} or a single parameter object. It will be then
used as substitution parameters within the message.
key | the key of the i18n message |
---|---|
parameters | This can be an Array, a List and Array or a single object parameter |
Called to return the un-formatted text of the specified i18n key or the key itself if no message can be found
key | the key of the i18n message |
---|
Same as getUnescapedText(String)
but does not apply any TranslationTransform
s.
key | the key of the i18n message |
---|
For the given key, checks whether such a key is defined in the locale context represented by this helper instance. Note that the actual translation may be in the 'fallback' default locale rather than the current locale.
The contract of this is method is correlated with getUntransformedRawText(String)
, whereby if this
method returns false
, getUntransformedRawText(String)
will return the key provided as an
argument, and if this method returns true
, getUntransformedRawText(String)
will generally
return the translation, which in some very unlikely cases may be equal to the key.
key | translation key |
---|
true
, if any translation for such key exists, false
otherwise
This can be called to get a component from the ComponentAccessor
. Override this if you
wish to change this behaviour say in unit tests.
clazz | the component class in question |
---|
Checks if descriptorParams contains key and removes it, otherwise adds the error message with the given message key.
params | the map of parameters |
---|---|
key | the param key to remove. |
messageKey | the error. |