Package com.atlassian.confluence.plugin.descriptor

Class VelocityContextItemModuleDescriptor

java.lang.Object
com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Object>
com.atlassian.confluence.plugin.descriptor.VelocityContextItemModuleDescriptor
All Implemented Interfaces:
PluginModuleFactory<Object>, com.atlassian.plugin.ModuleDescriptor<Object>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.StateAware
public final class VelocityContextItemModuleDescriptor extends com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Object> implements PluginModuleFactory<Object>
A module descriptor to add items to the Velocity contexts used everywhere.

Note: Items must have a zero argument constructor.

  • Field Summary

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

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

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    createModule()
     
    void
    disabled()
     
    void
    enabled()
     
    String
    getContextKey()
     
    Object
    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

    • VelocityContextItemModuleDescriptor

      public VelocityContextItemModuleDescriptor(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<Object>
      Overrides:
      init in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Object>
      Throws:
      com.atlassian.plugin.PluginParseException

    • getModule

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

    • enabled

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

    • disabled

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

    • createModule

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

    • getContextKey

      public String getContextKey()