com.atlassian.jira.plugin.userformat.descriptors

Class UserFormatModuleDescriptorImpl

java.lang.Object

com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>

com.atlassian.jira.plugin.AbstractJiraModuleDescriptor<UserFormat>

com.atlassian.jira.plugin.userformat.descriptors.UserFormatModuleDescriptorImpl

All Implemented Interfaces:

JiraResourcedModuleDescriptor<UserFormat>, UserFormatModuleDescriptor, com.atlassian.plugin.ModuleDescriptor<UserFormat>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.StateAware

public class UserFormatModuleDescriptorImpl
extends AbstractJiraModuleDescriptor<UserFormat>
implements UserFormatModuleDescriptor

Since:

v3.13

Field Summary

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

key, moduleClass, moduleClassName, moduleFactory, name, plugin, resources

Constructor Summary

Constructors

Constructor and Description
UserFormatModuleDescriptorImpl(JiraAuthenticationContext authenticationContext, com.atlassian.plugin.module.ModuleFactory moduleFactory)

Method Summary

Modifier and Type	Method and Description
void	disabled()
void	enabled()
boolean	equals(Object obj)
UserFormat	getModule()
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.
int	hashCode()
void	init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)

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

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

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

assertModuleClassImplements, checkPermissions, destroy, getCompleteKey, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getModuleClassName, getParams, getPlugin, getPluginKey, getRequiredPermissions, getResourceDescriptor, getResourceDescriptors, getResourceLocation, getScopeKey, isBroken, isEnabled, isEnabledByDefault, isSystemModule, loadClass, provideValidationRules, satisfiesMinJavaVersion, setBroken, setPlugin, toString

Methods inherited from class java.lang.Object

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

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

getHtml, getHtml, getI18nBean, writeHtml

Methods inherited from interface com.atlassian.plugin.ModuleDescriptor

destroy, getCompleteKey, getDescription, getDescriptionKey, getDisplayName, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getName, getParams, getPlugin, getPluginKey, isBroken, isEnabled, isEnabledByDefault, isSystemModule, satisfiesMinJavaVersion, setBroken

Methods inherited from interface com.atlassian.plugin.ScopeAware

getScopeKey

Methods inherited from interface com.atlassian.plugin.Resourced

getResourceDescriptor, getResourceDescriptors, getResourceLocation

Constructor Detail

UserFormatModuleDescriptorImpl

public UserFormatModuleDescriptorImpl(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 AbstractJiraModuleDescriptor<UserFormat>

Throws:

com.atlassian.plugin.PluginParseException

enabled

public void enabled()

Specified by:

enabled in interface com.atlassian.plugin.StateAware

Overrides:

enabled in class AbstractJiraModuleDescriptor<UserFormat>

disabled

public void disabled()

Specified by:

disabled in interface com.atlassian.plugin.StateAware

Overrides:

disabled in class AbstractJiraModuleDescriptor<UserFormat>

getType

public String getType()

Description copied from interface: UserFormatModuleDescriptor

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

Specified by:

getType in interface UserFormatModuleDescriptor

Returns:

The user format "type" for this descriptor.

getTypeI18nKey

public String getTypeI18nKey()

Description copied from interface: UserFormatModuleDescriptor

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

Specified by:

getTypeI18nKey in interface UserFormatModuleDescriptor

Returns:

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

getModule

public UserFormat getModule()

Specified by:

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

Overrides:

getModule in class AbstractJiraModuleDescriptor<UserFormat>

equals

public boolean equals(Object obj)

Specified by:

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

Overrides:

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

hashCode

public int hashCode()

Specified by:

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

Overrides:

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