com.atlassian.jira.plugin.profile
Class UserFormatModuleDescriptor

java.lang.Object
  extended by com.atlassian.plugin.descriptors.AbstractModuleDescriptor
      extended by com.atlassian.jira.plugin.JiraResourcedModuleDescriptor
          extended by com.atlassian.jira.plugin.profile.UserFormatModuleDescriptor
All Implemented Interfaces:
com.atlassian.plugin.ModuleDescriptor, com.atlassian.plugin.Resourced

public class UserFormatModuleDescriptor
extends JiraResourcedModuleDescriptor

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
plugin, resources, singleton
 
Constructor Summary
UserFormatModuleDescriptor(JiraAuthenticationContext authenticationContext)
           
 
Method Summary
 Object getModule()
           
 String getType()
           
 String getTypeI18nKey()
           
 void init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)
           
 
Methods inherited from class com.atlassian.jira.plugin.JiraResourcedModuleDescriptor
assertResourceExists, createVelocityParams, getAuthenticationContext, getClassLoader, getDescription, getHtml, getHtml, getI18nBean, getI18nLocations, 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, 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)
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
Overrides:
init in class JiraResourcedModuleDescriptor
Throws:
com.atlassian.plugin.PluginParseException

getType

public String getType()

getTypeI18nKey

public String getTypeI18nKey()

getModule

public Object getModule()
Specified by:
getModule in interface com.atlassian.plugin.ModuleDescriptor
Specified by:
getModule in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor


Copyright © 2002-2008 Atlassian. All Rights Reserved.