com.atlassian.jira.plugin.userformat
Class UserFormatModuleDescriptor

java.lang.Object
  com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
      com.atlassian.jira.plugin.JiraResourcedModuleDescriptor<UserFormat>
          com.atlassian.jira.plugin.userformat.UserFormatModuleDescriptor

All Implemented Interfaces:

com.atlassian.plugin.ModuleDescriptor<UserFormat>, com.atlassian.plugin.Resourced, com.atlassian.plugin.StateAware

public abstract class UserFormatModuleDescriptor
extends JiraResourcedModuleDescriptor<UserFormat>

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.

Since:

v4.4

See Also:

UserFormat

Field Summary

Fields inherited from class com.atlassian.jira.plugin.JiraResourcedModuleDescriptor

RESOURCE_TYPE_I18N

Fields inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

moduleClass, moduleClassName, plugin, resources, singleton

Constructor Summary

UserFormatModuleDescriptor(JiraAuthenticationContext authenticationContext, com.atlassian.plugin.module.ModuleFactory moduleFactory)

Method Summary

abstract String	getType() Gets the user format "type" that this descriptor applies to.
abstract String	getTypeI18nKey() Gets an i18n key to display a user friendly description for the type that this descriptor applies to.

Methods inherited from class com.atlassian.jira.plugin.JiraResourcedModuleDescriptor

assertResourceExists, createModule, createVelocityParams, disabled, enabled, getAuthenticationContext, getClassLoader, getDescription, getHtml, getHtml, getI18nBean, getModule, getName, getText, getText, init, isResourceExist

Methods inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

assertModuleClassImplements, destroy, equals, getCompleteKey, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getParams, getPlugin, getPluginKey, getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation, hashCode, isEnabledByDefault, isSingleton, isSingletonByDefault, isSystemModule, loadClass, loadClass, provideValidationRules, satisfiesMinJavaVersion, setPlugin, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UserFormatModuleDescriptor

public UserFormatModuleDescriptor(JiraAuthenticationContext authenticationContext,
                                  com.atlassian.plugin.module.ModuleFactory moduleFactory)

Method Detail

getType

public abstract String getType()

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

Returns:

The user format "type" for this descriptor.

getTypeI18nKey

public abstract 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.