Package com.atlassian.confluence.plugin.descriptor

Class BulkExtractorModuleDescriptor

java.lang.Object
com.atlassian.plugin.descriptors.AbstractModuleDescriptor<BulkExtractor<?>>
com.atlassian.confluence.plugin.descriptor.BulkExtractorModuleDescriptor
All Implemented Interfaces:
PluginModuleFactory<BulkExtractor<?>>, com.atlassian.plugin.ModuleDescriptor<BulkExtractor<?>>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.StateAware, Comparable<BulkExtractorModuleDescriptor>
@Internal @ExperimentalApi public final class BulkExtractorModuleDescriptor extends com.atlassian.plugin.descriptors.AbstractModuleDescriptor<BulkExtractor<?>> implements Comparable<BulkExtractorModuleDescriptor>, PluginModuleFactory<BulkExtractor<?>>
A module descriptor that allows plugin to add an BulkExtractor into indexing pipeline. e.g. 
 
     <bulk-extractor name="extraCommentDataExtractor" key="extraCommentDataExtractor"
                 class="com.atlassian.confluence.plugins.extractor.tutorial.ExtraCommentDataExtractor"
                 priority="1100" index="CONTENT">
     </bulk-extractor>
Since:
7.14

  • Field Summary

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

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    BulkExtractorModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    compareTo(BulkExtractorModuleDescriptor other)
    Module descriptors naturally sort from least to most priority
    BulkExtractor<?>
    createModule()
     
    void
    disabled()
     
    void
    enabled()
     
    BulkExtractor<?>
    getModule()
     
    int
    getPriority()
     
    SearchIndex
    getSearchIndex()
     
    void
    init(@NonNull com.atlassian.plugin.Plugin plugin, @NonNull com.atlassian.plugin.module.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, satisfiesMinJavaVersion, setBroken, setPlugin, toString, validate

    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 Details

    • BulkExtractorModuleDescriptor

      public BulkExtractorModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory)

  • Method Details

    • init

      public void init(@NonNull com.atlassian.plugin.Plugin plugin, @NonNull com.atlassian.plugin.module.Element element) throws com.atlassian.plugin.PluginParseException
      Specified by:
      init in interface com.atlassian.plugin.ModuleDescriptor<BulkExtractor<?>>
      Overrides:
      init in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<BulkExtractor<?>>
      Throws:
      com.atlassian.plugin.PluginParseException

    • getModule

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

    • enabled

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

    • disabled

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

    • getPriority

      public int getPriority()

    • getSearchIndex

      public SearchIndex getSearchIndex()

    • compareTo

      public int compareTo(BulkExtractorModuleDescriptor other)
      Module descriptors naturally sort from least to most priority
      Specified by:
      compareTo in interface Comparable<BulkExtractorModuleDescriptor>

    • createModule

      public BulkExtractor<?> createModule()
      Specified by:
      createModule in interface PluginModuleFactory<BulkExtractor<?>>