Package com.atlassian.confluence.impl.macro.schema

Class MacroSchemaMigratorModuleDescriptor

java.lang.Object
com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
com.atlassian.confluence.plugin.descriptor.DefaultFactoryModuleDescriptor<MacroMigration>
com.atlassian.confluence.impl.macro.schema.MacroSchemaMigratorModuleDescriptor
All Implemented Interfaces:
com.atlassian.plugin.ModuleDescriptor<MacroMigration>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.StateAware
public final class MacroSchemaMigratorModuleDescriptor extends DefaultFactoryModuleDescriptor<MacroMigration>
Defines a migration for a macro schema, where a macro schema is the shape of a macro's parameters in a MacroDefinition, and a MacroMigration transforms that MacroDefinition.

since 5.8

  • Field Summary

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

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

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getMacroName()
     
    MacroMigration
    getModule()
    Implementing classes should implement this method and call getModuleFromProvider, this is required as AbstractModuleDescriptor.getModuleReturnClass() uses the return type of this method to determine the module class.
    int
    getSchemaVersion()
     
    void
    init(@NonNull com.atlassian.plugin.Plugin plugin, @NonNull com.atlassian.plugin.module.Element element)
     

    Methods inherited from class com.atlassian.confluence.plugin.descriptor.DefaultFactoryModuleDescriptor

    disabled, enabled, getModuleFromProvider

    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

    • MacroSchemaMigratorModuleDescriptor

      public MacroSchemaMigratorModuleDescriptor(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)
      Specified by:
      init in interface com.atlassian.plugin.ModuleDescriptor<MacroMigration>
      Overrides:
      init in class DefaultFactoryModuleDescriptor<MacroMigration>

    • getModule

      public MacroMigration getModule()
      Description copied from class: DefaultFactoryModuleDescriptor
      Implementing classes should implement this method and call getModuleFromProvider, this is required as AbstractModuleDescriptor.getModuleReturnClass() uses the return type of this method to determine the module class. The JVM's type erasure means that it must be implemented with a non-generic type for getModuleReturnClass() to succeed.
      Specified by:
      getModule in interface com.atlassian.plugin.ModuleDescriptor<MacroMigration>
      Specified by:
      getModule in class DefaultFactoryModuleDescriptor<MacroMigration>

    • getSchemaVersion

      public int getSchemaVersion()

    • getMacroName

      public String getMacroName()