Package com.atlassian.confluence.plugin.descriptor

Class UserMacroModuleDescriptor

java.lang.Object
com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Macro>
com.atlassian.confluence.plugin.descriptor.UserMacroModuleDescriptor
All Implemented Interfaces:
MacroMetadataSource, PluginModuleFactory<Macro>, com.atlassian.plugin.ModuleDescriptor<Macro>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.StateAware
public final class UserMacroModuleDescriptor extends com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Macro> implements PluginModuleFactory<Macro>, MacroMetadataSource
Allows simple macros to be defined inline

  • Field Summary

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

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    UserMacroModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory, MacroMetadataParser macroMetadataParser)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Macro
    createModule()
     
    void
    disabled()
     
    void
    enabled()
     
    MacroMetadata
    getMacroMetadata()
     
    Macro
    getModule()
     
    UserMacroConfig
    getUserMacroConfig()
     
    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

    • UserMacroModuleDescriptor

      public UserMacroModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory, MacroMetadataParser macroMetadataParser)

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

    • getUserMacroConfig

      public UserMacroConfig getUserMacroConfig()

    • getMacroMetadata

      public MacroMetadata getMacroMetadata()
      Specified by:
      getMacroMetadata in interface MacroMetadataSource

    • createModule

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

    • getModule

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

    • enabled

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

    • disabled

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