Package com.atlassian.confluence.impl.plugin.descriptor.search

Class AbstractLuceneMapperModuleDescriptor<T>

  • All Implemented Interfaces:
    com.atlassian.plugin.ModuleDescriptor<T>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.StateAware
    Direct Known Subclasses:
    LuceneQueryMapperModuleDescriptor, LuceneSortMapperModuleDescriptor
    public abstract class AbstractLuceneMapperModuleDescriptor<T>
extends com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
    From 8.8, calling getModule() with OpenSearch config will return null as we don't support this module descriptor for OpenSearch

    • Field Summary

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

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void disabled()  
      void enabled()  
      Collection<String> getHandledKeys()  
      T getModule()  
      protected PluginModuleFactory<T> getModuleFactory()  
      boolean handles​(String key)  
      void init​(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)  
      boolean isEnabled()  

      • 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, isEnabledByDefault, isSystemModule, loadClass, provideValidationRules, satisfiesMinJavaVersion, setBroken, setPlugin, toString, validate

      • Methods inherited from interface com.atlassian.plugin.ModuleDescriptor

        getDisplayName, init

    • Constructor Detail

      • AbstractLuceneMapperModuleDescriptor

        protected AbstractLuceneMapperModuleDescriptor​(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<T>
        Overrides:
        init in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
        Throws:
        com.atlassian.plugin.PluginParseException

      • handles

        public boolean handles​(String key)

      • getHandledKeys

        public Collection<String> getHandledKeys()
        Returns:
        the keys that are handled by the module.

      • getModule

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

      • isEnabled

        public boolean isEnabled()
        Specified by:
        isEnabled in interface com.atlassian.plugin.ModuleDescriptor<T>
        Overrides:
        isEnabled in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>

      • enabled

        public void enabled()
        Specified by:
        enabled in interface com.atlassian.plugin.StateAware
        Overrides:
        enabled in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>

      • disabled

        public void disabled()
        Specified by:
        disabled in interface com.atlassian.plugin.StateAware
        Overrides:
        disabled in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>