public interface

UserFormatModuleDescriptor

implements JiraResourcedModuleDescriptor<T>
com.atlassian.jira.plugin.userformat.UserFormatModuleDescriptor
Known Indirect Subclasses

Class Overview

A module descriptor that produces a UserFormat that can be used to format a user for display. The provided user formats are tied to a "type".

There can be many user formats for a specific "type", but only one of them will be used when formatting the user name.

Administrators configure which user format to use for a specific type in UI.

See Also

Summary

Public Methods
String getType()
Gets the user format "type" that this descriptor applies to.
String getTypeI18nKey()
Gets an i18n key to display a user friendly description for the type that this descriptor applies to.
[Expand]
Inherited Methods
From interface com.atlassian.jira.plugin.JiraResourcedModuleDescriptor
From interface com.atlassian.plugin.ModuleDescriptor
From interface com.atlassian.plugin.Resourced

Public Methods

public String getType ()

Gets the user format "type" that this descriptor applies to.

Returns
  • The user format "type" for this descriptor.

public String getTypeI18nKey ()

Gets an i18n key to display a user friendly description for the type that this descriptor applies to.

Returns
  • An i18n key to display a user friendly description for the type.