com.atlassian.plugin.ModuleDescriptor<T> |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Override this if your plugin needs to clean up when it's been removed.
| |||||||||||
Compares the specified object with this module descriptor for equality. | |||||||||||
The complete key for this module, including the plugin key.
| |||||||||||
A simple description of this descriptor.
| |||||||||||
Key used to override
getDescription() when using
internationalisation. | |||||||||||
Key used to override
getName() when using internationalisation. | |||||||||||
The key for this module, unique within the plugin.
| |||||||||||
The particular module object created by this plugin.
| |||||||||||
The class of the module this descriptor creates.
| |||||||||||
A simple string name for this descriptor.
| |||||||||||
The plugin key for this module, derived from the complete key.
| |||||||||||
Returns the hash code value for this module descriptor.
| |||||||||||
Initialise a module given it's parent plugin and the XML element
representing the module.
| |||||||||||
Whether or not this plugin module is enabled by default.
| |||||||||||
Whether or not this plugin module is a "system" plugin that shouldn't be
made visible/disableable to the user.
| |||||||||||
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
|
Override this if your plugin needs to clean up when it's been removed.
plugin | TODO: The plugin parameter is redundant. The ModuleDescriptor must know its parent plugin in order to implement getPlugin() |
---|
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()
.
obj | object to be compared for equality with this module descriptor. |
---|
The complete key for this module, including the plugin key.
Format is plugin.key:module.key
A simple description of this descriptor.
Key used to override getDescription()
when using
internationalisation.
Key used to override getName()
when using internationalisation.
The key for this module, unique within the plugin.
The particular module object created by this plugin.
The class of the module this descriptor creates.
A simple string name for this descriptor.
The plugin key for this module, derived from the complete key.
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.
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.
plugin | The plugin that the module belongs to. Must not be null. |
---|---|
element | XML element representing the module. Must not be null. |
PluginParseException | Can be thrown if an error occurs while parsing the XML element. |
---|
Whether or not this plugin module is enabled by default.
true
if this plugin module is enabled by default.
Whether or not this plugin module is a "system" plugin that shouldn't be made visible/disableable to the user.
true
if this plugin module is a "system" plugin that
shouldn't be made visible/disableable to the user.
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.