com.atlassian.jira.plugin.profile
Class UserFormatModuleDescriptor

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

All Implemented Interfaces:

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

public class UserFormatModuleDescriptor
extends JiraResourcedModuleDescriptor<UserFormat>

A module Descriptor that produces a UserFormat that can be used to format a user for display. Usually this will print the user's full name with a link to the user's profile.

Since:

v3.13

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

void	enabled()
UserFormat	getModule()
String	getType()
String	getTypeI18nKey()
void	init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)
void	onClearCache(ClearCacheEvent event)

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

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

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

UserFormatModuleDescriptor

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

Method Detail

init

public void init(com.atlassian.plugin.Plugin plugin,
                 org.dom4j.Element element)
          throws com.atlassian.plugin.PluginParseException

Specified by:

init in interface com.atlassian.plugin.ModuleDescriptor<UserFormat>

Overrides:

init in class JiraResourcedModuleDescriptor<UserFormat>

Throws:

com.atlassian.plugin.PluginParseException

enabled

public void enabled()

Specified by:

enabled in interface com.atlassian.plugin.StateAware

Overrides:

enabled in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<UserFormat>

getType

public String getType()

getTypeI18nKey

public String getTypeI18nKey()

getModule

public UserFormat getModule()

Specified by:

getModule in interface com.atlassian.plugin.ModuleDescriptor<UserFormat>

Overrides:

getModule in class JiraResourcedModuleDescriptor<UserFormat>

onClearCache

@EventListener
public void onClearCache(ClearCacheEvent event)