Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.atlassian.jira.util
Interface I18nHelper

public interface I18nHelper

I18nHelper is the main interface for finding internationalised text in JIRA.

You should only use the i18nHelper in your code which generally you get from JiraAuthenticationContext.getI18nHelper()

You MUST never directly instantiate the underlying I18nBean. You will get it wrong and miss out on cool stuff like flyweight caching.

Nested Class Summary
static interface I18nHelper.BeanFactory
          Ths BeanFactory is used to instantiate I18nHelper instances
 
Method Summary
 ResourceBundle getDefaultResourceBundle()
           
 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()
           
 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 parameters)
          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
 

Method Detail

getLocale

Locale getLocale()
Returns:
the Locale that is associated with this I18nHelper

getDefaultResourceBundle

ResourceBundle getDefaultResourceBundle()
Returns:
the default ResourceBundle within JIRA

getUnescapedText

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

Parameters:
key - the key of the i18n message
Returns:
the un-formatted text or the key itself if no i18n message can be found

getText

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

Parameters:
key - the key of the i18n message
Returns:
the formatted text or the key itself if no i18n message can be found

getText

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

Parameters:
key - the key of the i18n message
value1 - a value to be substituted into the message
Returns:
the formatted text or the key itself if no i18n message can be found

getText

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

Parameters:
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
Returns:
the formatted text or the key itself if no i18n message can be found

getText

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

Parameters:
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
Returns:
the formatted text or the key itself if no i18n message can be found

getText

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

Parameters:
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
Returns:
the formatted text or the key itself if no i18n message can be found

getText

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

Parameters:
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
Returns:
the formatted text or the key itself if no i18n message can be found

getText

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

Parameters:
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
Returns:
the formatted text or the key itself if no i18n message can be found

getText

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

Parameters:
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
Returns:
the formatted text or the key itself if no i18n message can be found

getText

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

Parameters:
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
Returns:
the formatted text or the key itself if no i18n message can be found

getText

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

Parameters:
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
Returns:
the formatted text or the key itself if no i18n message can be found

getText

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

Parameters:
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
Returns:
the formatted text or the key itself if no i18n message can be found

getText

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

Parameters:
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
Returns:
the formatted text or the key itself if no i18n message can be found

getText

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

Parameters:
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
Returns:
the formatted text or the key itself if no i18n message can be found

getText

String getText(String key,
               Object parameters)
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.

Parameters:
key - the key of the i18n message
parameters - This can be an Array, a List and Array or a single object parameter
Returns:
the formatted text or the key itself if no i18n message can be found

getKeysForPrefix

Set<String> getKeysForPrefix(String prefix)
Given a prefix for an i18n key, this method will return all keys that start with the prefix specified.

Parameters:
prefix - The prefix for i18n keys. May not be null
Returns:
An immutable set of translation keys that start with the prefix specified.
Since:
4.0.1
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2002-2011 Atlassian. All Rights Reserved.