public class

PropertySetBackedUserFormatTypeConfiguration

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

Class Overview

Responsible for storing the configured user format modules for each user format type in a property set.

The underlying property set stores the name of a user format type as a key an its value is the plugin module key of the user format descriptor currently configured for that type.

Summary

Public Constructors
PropertySetBackedUserFormatTypeConfiguration(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.
@EventListener void onClearCache(ClearCacheEvent 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 PropertySetBackedUserFormatTypeConfiguration (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.

@EventListener public void onClearCache (ClearCacheEvent 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 .