com.atlassian.confluence.plugin.descriptor

Class SearchDecoratorModuleDescriptor

java.lang.Object

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

com.atlassian.confluence.plugin.descriptor.SearchDecoratorModuleDescriptor

All Implemented Interfaces:

PluginModuleFactory<SearchDecorator>, com.atlassian.plugin.ModuleDescriptor<SearchDecorator>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.StateAware, com.atlassian.plugin.web.descriptors.WeightedDescriptor

@Internal
public class SearchDecoratorModuleDescriptor
extends com.atlassian.plugin.descriptors.AbstractModuleDescriptor<SearchDecorator>
implements com.atlassian.plugin.web.descriptors.WeightedDescriptor, PluginModuleFactory<SearchDecorator>

A module descriptor that allows to add a SearchDecorator into Confluence. To register a decorator, add the following configuration in to a atlassian-plugin.xml e.g.

 
  <search-decorator key="mySearchDecorator" class="com.mycompany.mypackage.MySearchDecorator" weight="1"/>
  
 

Since:

7.0.1

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
SearchDecoratorModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory)

Method Summary

Modifier and Type	Method and Description
SearchDecorator	createModule()
void	disabled()
void	enabled()
SearchDecorator	getModule()
int	getWeight()
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

SearchDecoratorModuleDescriptor

public SearchDecoratorModuleDescriptor(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<SearchDecorator>

Overrides:

init in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<SearchDecorator>

Throws:

com.atlassian.plugin.PluginParseException

getModule

public SearchDecorator getModule()

Specified by:

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

Specified by:

getModule in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<SearchDecorator>

createModule

public SearchDecorator createModule()

Specified by:

createModule in interface PluginModuleFactory<SearchDecorator>

enabled

public void enabled()

Specified by:

enabled in interface com.atlassian.plugin.StateAware

Overrides:

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

disabled

public void disabled()

Specified by:

disabled in interface com.atlassian.plugin.StateAware

Overrides:

disabled in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<SearchDecorator>

getWeight

public int getWeight()

Specified by:

getWeight in interface com.atlassian.plugin.web.descriptors.WeightedDescriptor