com.atlassian.greenhopper.plugin.module
Enum ModuleDefinition

java.lang.Object
  java.lang.Enum<ModuleDefinition>
      com.atlassian.greenhopper.plugin.module.ModuleDefinition

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ModuleDefinition>

public enum ModuleDefinition
extends java.lang.Enum<ModuleDefinition>

Contains all the module definitions that can be dynamically loaded by the ModuleLoader based on the ModuleContext.

Enum Constant Summary

CAPABILITIES

CAPABILITIES_SINCE_611

GADGETS

HEALTH_CHECKS

REMOTE_LINK_AGGREGATORS

RESOURCE_BACKPORTS_60

RESOURCE_EXPANDER_60

RESOURCE_EXPANDER_61

RESOURCE_ISSUE_STATUS_60

RESOURCE_ISSUE_STATUS_61

RESOURCE_SPINNER_60

RESOURCE_SPINNER_61

RESOURCE_TOOLTIPS_60

Method Summary

static java.util.List<ModuleDefinition>	getDefinitionsForContext(ModuleContext ctx) Returns an List containing the module definitions applicable for the given PluginModuleContext.
java.util.List<ModuleDefinition>	getDependencies() Returns a list of ModuleDefinition that are dependencies this module relies on being loaded before it can be loaded successfully.
java.lang.String	getFileName() Returns the file name of the file that contains the module's xml contribution to the plugin's atlassian-plugin.xml file.
abstract boolean	isApplicable(ModuleContext ctx) Checks if the module is applicable for the given context.
static ModuleDefinition	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ModuleDefinition[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CAPABILITIES

public static final ModuleDefinition CAPABILITIES

CAPABILITIES_SINCE_611

public static final ModuleDefinition CAPABILITIES_SINCE_611

HEALTH_CHECKS

public static final ModuleDefinition HEALTH_CHECKS

RESOURCE_BACKPORTS_60

public static final ModuleDefinition RESOURCE_BACKPORTS_60

RESOURCE_EXPANDER_61

public static final ModuleDefinition RESOURCE_EXPANDER_61

RESOURCE_EXPANDER_60

public static final ModuleDefinition RESOURCE_EXPANDER_60

RESOURCE_SPINNER_61

public static final ModuleDefinition RESOURCE_SPINNER_61

RESOURCE_SPINNER_60

public static final ModuleDefinition RESOURCE_SPINNER_60

RESOURCE_ISSUE_STATUS_61

public static final ModuleDefinition RESOURCE_ISSUE_STATUS_61

RESOURCE_ISSUE_STATUS_60

public static final ModuleDefinition RESOURCE_ISSUE_STATUS_60

RESOURCE_TOOLTIPS_60

public static final ModuleDefinition RESOURCE_TOOLTIPS_60

GADGETS

public static final ModuleDefinition GADGETS

REMOTE_LINK_AGGREGATORS

public static final ModuleDefinition REMOTE_LINK_AGGREGATORS

Method Detail

values

public static ModuleDefinition[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ModuleDefinition c : ModuleDefinition.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ModuleDefinition valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getDefinitionsForContext

public static java.util.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 java.lang.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 java.util.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 abstract boolean isApplicable(ModuleContext ctx)

Checks if the module is applicable for the given context.

Parameters:

ctx -

Returns: