Package com.atlassian.confluence.plugin.descriptor

Class PathConverterModuleDescriptor

java.lang.Object
com.atlassian.plugin.descriptors.AbstractModuleDescriptor<PathConverter>
com.atlassian.confluence.plugin.descriptor.PathConverterModuleDescriptor
All Implemented Interfaces:
com.atlassian.plugin.ModuleDescriptor<PathConverter>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.StateAware
public final class PathConverterModuleDescriptor extends com.atlassian.plugin.descriptors.AbstractModuleDescriptor<PathConverter>
A plugin module descriptor used to load path converter plugins.

This descriptor will register the path converters with the manager as they are enabled, and remove them as they are disabled.

  • Field Summary

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

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    PathConverterModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory, PathConverterManager pathConverterManager)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    disabled()
     
    void
    enabled()
     
    PathConverter
    getModule()
     
    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

    • PathConverterModuleDescriptor

      public PathConverterModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory, PathConverterManager pathConverterManager)

  • 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<PathConverter>
      Overrides:
      init in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<PathConverter>
      Throws:
      com.atlassian.plugin.PluginParseException

    • getModule

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

    • enabled

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

    • disabled

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