Package com.atlassian.jira.i18n

Class CachingI18nFactory

java.lang.Object

com.atlassian.jira.i18n.CachingI18nFactory

All Implemented Interfaces:

Startable, InitializingComponent, I18nHelper.BeanFactory

public class CachingI18nFactory
extends Object
implements I18nHelper.BeanFactory, InitializingComponent, Startable

As the name implies: a factory that caches for different locales I18nHelper.

With the advent of Plugins-2 we need to iterate through all enabled plugins and get their i18n resources when an I18nHelper is required.

Constructor Summary

Constructors

Constructor	Description
CachingI18nFactory(JiraLocaleUtils jiraLocaleUtils, com.atlassian.event.api.EventPublisher eventPublisher, BackingI18nFactory i18nBackingFactory, UserLocaleStore userLocaleStore, ComponentLocator locator, ResourceBundleCacheCleaner resourceBundleCacheCleaner)	Constructs factory in setup mode SetupContainerRegistrar, that does not apply TerminologyVersionTracker.getVersionHashCode() to getStateHashCode()
CachingI18nFactory(JiraLocaleUtils jiraLocaleUtils, com.atlassian.event.api.EventPublisher eventPublisher, BackingI18nFactory i18nBackingFactory, UserLocaleStore userLocaleStore, ComponentLocator locator, ResourceBundleCacheCleaner resourceBundleCacheCleaner, TerminologyVersionTracker terminologyVersionTracker)	Constructs factory that does apply TerminologyVersionTracker.getVersionHashCode() to getStateHashCode()

Method Summary

Modifier and Type	Method	Description
void	afterInstantiation()
I18nHelper	getInstance(ApplicationUser user)	Returns an I18nHelper instance associated with the provided User's locale preference.
I18nHelper	getInstance(Locale locale)	Returns an I18nHelper instance associated with the provided Locale.
String	getStateHashCode()	An opaque string that changes whenever the underlying i18n bundles change (e.g.
void	onJiraPluginCacheResetEvent(JiraPluginCacheResetEvent event)
void	onTerminologyChangeEvent(TerminologyCacheClearedEvent event)
void	start()	This method will be called after the plugin system is fully initialised and all components added to the dependency injection framework.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CachingI18nFactory

public CachingI18nFactory(JiraLocaleUtils jiraLocaleUtils,
 com.atlassian.event.api.EventPublisher eventPublisher,
 BackingI18nFactory i18nBackingFactory,
 UserLocaleStore userLocaleStore,
 ComponentLocator locator,
 ResourceBundleCacheCleaner resourceBundleCacheCleaner)

Constructs factory in setup mode SetupContainerRegistrar, that does not apply TerminologyVersionTracker.getVersionHashCode() to getStateHashCode()

CachingI18nFactory

public CachingI18nFactory(JiraLocaleUtils jiraLocaleUtils,
 com.atlassian.event.api.EventPublisher eventPublisher,
 BackingI18nFactory i18nBackingFactory,
 UserLocaleStore userLocaleStore,
 ComponentLocator locator,
 ResourceBundleCacheCleaner resourceBundleCacheCleaner,
 TerminologyVersionTracker terminologyVersionTracker)

Constructs factory that does apply TerminologyVersionTracker.getVersionHashCode() to getStateHashCode()

Method Details

start

public void start()

Description copied from interface: Startable

This method will be called after the plugin system is fully initialised and all components added to the dependency injection framework.

Specified by:

start in interface Startable

afterInstantiation

public void afterInstantiation()

Specified by:

afterInstantiation in interface InitializingComponent

onJiraPluginCacheResetEvent

@EventListener
public void onJiraPluginCacheResetEvent(JiraPluginCacheResetEvent event)

onTerminologyChangeEvent

@EventListener
public void onTerminologyChangeEvent(TerminologyCacheClearedEvent event)

getInstance

@Nonnull
public I18nHelper getInstance(Locale locale)

Description copied from interface: I18nHelper.BeanFactory

Returns an I18nHelper instance associated with the provided Locale. Note that since JIRA 6.0 you can have an I18nHelper injected directly into your class, and it will be specific to the currently logged in user.

Specified by:

getInstance in interface I18nHelper.BeanFactory

Parameters:

locale - the locale in play

Returns:

an I18nHelper instance associated with the provided Locale

getInstance

@Nonnull
public I18nHelper getInstance(ApplicationUser user)

Description copied from interface: I18nHelper.BeanFactory

Returns an I18nHelper instance associated with the provided User's locale preference. Note that since JIRA 6.0 you can have an I18nHelper injected directly into your class, and it will be specific to the currently logged in user.

Specified by:

getInstance in interface I18nHelper.BeanFactory

Parameters:

user - the user in play

Returns:

an I18nHelper instance associated with the provided User's locale preference

getStateHashCode

public String getStateHashCode()

An opaque string that changes whenever the underlying i18n bundles change (e.g. when a new translation pack is installed)