public class

PluginsAwareUserFormatTypeConfiguration

extends Object
implements UserFormatTypeConfiguration
java.lang.Object
   ↳ com.atlassian.jira.plugin.userformat.configuration.PluginsAwareUserFormatTypeConfiguration

Class Overview

Reacts to plugin system events and updates the user format configuration accordingly.

Delegates storage and retrieval to an instance of PropertySetBackedUserFormatTypeConfiguration

Summary

Public Constructors
PluginsAwareUserFormatTypeConfiguration(JiraPropertySetFactory jiraPropertySetFactory, CacheManager cacheManager)
Public Methods
boolean containsType(String userFormatType)
Whether there is a configuration entry stored for the specified type.
String getUserFormatKeyForType(String userFormatType)
Retrieves the module key of the user format descriptor configured to render the specified type.
void onPluginUninstalled(PluginUninstalledEvent event)
void remove(String userFormatType)
Removes the configuration entry for the specified type if one exists.
void setUserFormatKeyForType(String userFormatType, String moduleKey)
Stores a configuration entry for the specified type agains a user format module descriptor key.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.plugin.userformat.configuration.UserFormatTypeConfiguration

Public Constructors

public PluginsAwareUserFormatTypeConfiguration (JiraPropertySetFactory jiraPropertySetFactory, CacheManager cacheManager)

Public Methods

public boolean containsType (String userFormatType)

Whether there is a configuration entry stored for the specified type.

Parameters
userFormatType The type find a confiuration entry for.
Returns
  • true if there is configuration entry stored for the specified type; otherwise false.

public String getUserFormatKeyForType (String userFormatType)

Retrieves the module key of the user format descriptor configured to render the specified type.

Parameters
userFormatType The type to retrieve a module key for.
Returns
  • the module key of the user format descriptor configured to render the specified type, or null if there is no module key configured for that type.

public void onPluginUninstalled (PluginUninstalledEvent event)

public void remove (String userFormatType)

Removes the configuration entry for the specified type if one exists.

Parameters
userFormatType The type to remove from the configuration.

public void setUserFormatKeyForType (String userFormatType, String moduleKey)

Stores a configuration entry for the specified type agains a user format module descriptor key.

Parameters
userFormatType the user format type to configure.
moduleKey The complete module key of the .