public interface

ModuleDescriptor

implements Resourced
com.atlassian.plugin.ModuleDescriptor<T>
Known Indirect Subclasses

Summary

Public Methods
void destroy(Plugin plugin)
Override this if your plugin needs to clean up when it's been removed.
boolean equals(Object obj)

Compares the specified object with this module descriptor for equality.

String getCompleteKey()
The complete key for this module, including the plugin key.
String getDescription()
A simple description of this descriptor.
String getDescriptionKey()
Key used to override getDescription() when using internationalisation.
String getI18nNameKey()
Key used to override getName() when using internationalisation.
String getKey()
The key for this module, unique within the plugin.
Float getMinJavaVersion()
T getModule()
The particular module object created by this plugin.
Class<T> getModuleClass()
The class of the module this descriptor creates.
String getName()
A simple string name for this descriptor.
Map<StringString> getParams()
Plugin getPlugin()
String getPluginKey()
The plugin key for this module, derived from the complete key.
int hashCode()
Returns the hash code value for this module descriptor.
void init(Plugin plugin, Element element)
Initialise a module given it's parent plugin and the XML element representing the module.
boolean isEnabledByDefault()
Whether or not this plugin module is enabled by default.
boolean isSystemModule()
Whether or not this plugin module is a "system" plugin that shouldn't be made visible/disableable to the user.
boolean satisfiesMinJavaVersion()
If a min java version has been specified this will return true if the running jvm is >= to the specified version.
[Expand]
Inherited Methods
From interface com.atlassian.plugin.Resourced

Public Methods

public void destroy (Plugin plugin)

Override this if your plugin needs to clean up when it's been removed.

Parameters
plugin TODO: The plugin parameter is redundant. The ModuleDescriptor must know its parent plugin in order to implement getPlugin()

public boolean equals (Object obj)

Compares the specified object with this module descriptor for equality.

Returns true if the given object is also a module descriptor and the two descriptors have the same "complete key" as determined by getCompleteKey().

This ensures that the equals method works properly across different implementations of the ModuleDescriptor interface.
Parameters
obj object to be compared for equality with this module descriptor.
Returns
  • true if the specified object is equal to this module descriptor.

public String getCompleteKey ()

The complete key for this module, including the plugin key.

Format is plugin.key:module.key

Returns
  • The complete key for this module.

public String getDescription ()

A simple description of this descriptor.

Returns
  • The description for this ModuleDescriptor.

public String getDescriptionKey ()

Key used to override getDescription() when using internationalisation.

Returns
  • the i18n key. May be null.

public String getI18nNameKey ()

Key used to override getName() when using internationalisation.

Returns
  • the i18n key. May be null.

public String getKey ()

The key for this module, unique within the plugin.

Returns
  • The key for this module.

public Float getMinJavaVersion ()

public T getModule ()

The particular module object created by this plugin.

Returns
  • The module object created by this plugin.
See Also

public Class<T> getModuleClass ()

The class of the module this descriptor creates.

Returns
  • The class of the module this descriptor creates.
See Also

public String getName ()

A simple string name for this descriptor.

Returns
  • The name for this ModuleDescriptor.

public Map<StringString> getParams ()

public Plugin getPlugin ()

Returns
  • The plugin this module descriptor is associated with

public String getPluginKey ()

The plugin key for this module, derived from the complete key.

Returns
  • The plugin key for this module.

public int hashCode ()

Returns the hash code value for this module descriptor. The hash code of a module descriptor d is defined to be:

     getCompleteKey() == null ? 0 : getCompleteKey().hashCode()
 
This ensures that d1.equals(d2) implies that d1.hashCode()==d2.hashCode() for any two Module Descriptors d1 and d2, as required by the general contract of Object.hashCode.
Returns
  • the hash code value for this module descriptor.

public void init (Plugin plugin, Element element)

Initialise a module given it's parent plugin and the XML element representing the module.

Since atlassian-plugins v2.2, you can no longer load classes from the plugin in this method, because the OSGi bundle that they will live in is not built yet. Load classes in the enabled() method instead.

Parameters
plugin The plugin that the module belongs to. Must not be null.
element XML element representing the module. Must not be null.
Throws
PluginParseException Can be thrown if an error occurs while parsing the XML element.

public boolean isEnabledByDefault ()

Whether or not this plugin module is enabled by default.

Returns
  • true if this plugin module is enabled by default.

public boolean isSystemModule ()

Whether or not this plugin module is a "system" plugin that shouldn't be made visible/disableable to the user.

Returns
  • true if this plugin module is a "system" plugin that shouldn't be made visible/disableable to the user.

public boolean satisfiesMinJavaVersion ()

If a min java version has been specified this will return true if the running jvm is >= to the specified version. If this is not set then it is treated as not having a preference.

Returns
  • true if satisfied, false otherwise.