com.atlassian.jira.plugin.index

Class EntityPropertyIndexDocumentModuleDescriptorImpl

java.lang.Object

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

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

com.atlassian.jira.plugin.index.EntityPropertyIndexDocumentModuleDescriptorImpl

All Implemented Interfaces:

EntityPropertyIndexDocumentModuleDescriptor, JiraResourcedModuleDescriptor<Void>, com.atlassian.plugin.ModuleDescriptor<Void>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.StateAware

public class EntityPropertyIndexDocumentModuleDescriptorImpl
extends AbstractJiraModuleDescriptor<Void>
implements EntityPropertyIndexDocumentModuleDescriptor

Descriptor of modules which specify how the properties are indexed. When to module is enabled it is persisted, so the properties are still indexed even if the plugin is disabled. The modules are removed only when the plugin is uninstalled or reinstalled.

Since:

v6.2

Field Summary

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

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	disabled()
void	enabled()
boolean	equals(Object obj)
IndexDocumentConfiguration	getIndexDocumentConfiguration()
int	hashCode()
void	init() Initializes this EntityPropertyIndexDocumentModuleDescriptor.
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, getModule, 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.plugin.ModuleDescriptor

destroy, getCompleteKey, getDescription, getDescriptionKey, getDisplayName, getI18nNameKey, getKey, getMinJavaVersion, getModule, 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

EntityPropertyIndexDocumentModuleDescriptorImpl

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

Method Detail

init

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

Specified by:

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

Overrides:

init in class AbstractJiraModuleDescriptor<Void>

Throws:

com.atlassian.plugin.PluginParseException

enabled

public void enabled()

Specified by:

enabled in interface com.atlassian.plugin.StateAware

Overrides:

enabled in class AbstractJiraModuleDescriptor<Void>

init

public void init()

Description copied from interface: EntityPropertyIndexDocumentModuleDescriptor

Initializes this EntityPropertyIndexDocumentModuleDescriptor. This may write configuration to db if not previously stored.

Specified by:

init in interface EntityPropertyIndexDocumentModuleDescriptor

disabled

public void disabled()

Specified by:

disabled in interface com.atlassian.plugin.StateAware

Overrides:

disabled in class AbstractJiraModuleDescriptor<Void>

equals

public boolean equals(Object obj)

Specified by:

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

Overrides:

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

hashCode

public int hashCode()

Specified by:

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

Overrides:

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

getIndexDocumentConfiguration

public IndexDocumentConfiguration getIndexDocumentConfiguration()

Specified by:

getIndexDocumentConfiguration in interface EntityPropertyIndexDocumentModuleDescriptor