Package com.atlassian.greenhopper.plugin.module

Enum Class ModuleDefinition

java.lang.Object
java.lang.Enum<ModuleDefinition>
com.atlassian.greenhopper.plugin.module.ModuleDefinition
All Implemented Interfaces:
Serializable, Comparable<ModuleDefinition>, Constable
public enum ModuleDefinition extends Enum<ModuleDefinition>
Contains all the module definitions that can be dynamically loaded by the ModuleLoader based on the ModuleContext.

  • Enum Constant Details

  • Method Details

    • values

      public static ModuleDefinition[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static ModuleDefinition valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getDefinitionsForContext

      public static List<ModuleDefinition> getDefinitionsForContext(ModuleContext ctx)
      Returns an List containing the module definitions applicable for the given PluginModuleContext. The order of the definitions in the list is based on the order they should be loaded and takes dependencies into account.
      Parameters:
      ctx -
      Returns:

    • getFileName

      public String getFileName()
      Returns the file name of the file that contains the module's xml contribution to the plugin's atlassian-plugin.xml file. This file must be in the same folder as atlassian-plugin.xml
      Returns:
      A file name.

    • getDependencies

      public List<ModuleDefinition> getDependencies()
      Returns a list of ModuleDefinition that are dependencies this module relies on being loaded before it can be loaded successfully.
      Returns:

    • isApplicable

      public boolean isApplicable(ModuleContext ctx)
      Checks if the module is applicable for the given context.
      Parameters:
      ctx -
      Returns: