com.atlassian.confluence.plugin.descriptor

Class AbstractExtractorModuleDescriptor

java.lang.Object

com.atlassian.plugin.descriptors.AbstractModuleDescriptor<com.atlassian.bonnie.search.Extractor>

com.atlassian.confluence.plugin.descriptor.AbstractExtractorModuleDescriptor

All Implemented Interfaces:

PluginModuleFactory<com.atlassian.bonnie.search.Extractor>, com.atlassian.plugin.ModuleDescriptor<com.atlassian.bonnie.search.Extractor>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.StateAware, Comparable

Direct Known Subclasses:

ChangeDocumentExtractorModuleDescriptor, ExtractorModuleDescriptor

public abstract class AbstractExtractorModuleDescriptor
extends com.atlassian.plugin.descriptors.AbstractModuleDescriptor<com.atlassian.bonnie.search.Extractor>
implements Comparable, PluginModuleFactory<com.atlassian.bonnie.search.Extractor>

Abstract class for extractor module descriptors

Field Summary

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

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractExtractorModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Object o) Module descriptors naturally sort from least to most priority
com.atlassian.bonnie.search.Extractor	createModule()
void	disabled()
void	enabled()
com.atlassian.bonnie.search.Extractor	getModule()
int	getPriority()
void	init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)

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

assertModuleClassImplements, checkPermissions, destroy, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getModuleClassName, getName, getParams, getPlugin, getPluginKey, getRequiredPermissions, getResourceDescriptor, getResourceDescriptors, getResourceLocation, getScopeKey, hashCode, 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

getDisplayName

Constructor Detail

AbstractExtractorModuleDescriptor

protected AbstractExtractorModuleDescriptor(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<com.atlassian.bonnie.search.Extractor>

Overrides:

init in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<com.atlassian.bonnie.search.Extractor>

Throws:

com.atlassian.plugin.PluginParseException

getModule

public com.atlassian.bonnie.search.Extractor getModule()

Specified by:

getModule in interface com.atlassian.plugin.ModuleDescriptor<com.atlassian.bonnie.search.Extractor>

Specified by:

getModule in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<com.atlassian.bonnie.search.Extractor>

enabled

public void enabled()

Specified by:

enabled in interface com.atlassian.plugin.StateAware

Overrides:

enabled in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<com.atlassian.bonnie.search.Extractor>

disabled

public void disabled()

Specified by:

disabled in interface com.atlassian.plugin.StateAware

Overrides:

disabled in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<com.atlassian.bonnie.search.Extractor>

getPriority

public int getPriority()

compareTo

public int compareTo(Object o)

Module descriptors naturally sort from least to most priority

Specified by:

compareTo in interface Comparable

createModule

public com.atlassian.bonnie.search.Extractor createModule()

Specified by:

createModule in interface PluginModuleFactory<com.atlassian.bonnie.search.Extractor>