java.lang.Object | |
↳ | com.atlassian.plugin.web.descriptors.DefaultAbstractWebFragmentModuleDescriptor |
Wrapper for WebFragmentModuleDescriptor
, so that it could be extended
by application specific wrappers to provide additional methods.
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From interface
com.atlassian.plugin.web.descriptors.WebFragmentModuleDescriptor
|
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Override this if your plugin needs to clean up when it's been removed.
| |||||||||||
Called by the plugin manager when the plugin or module is deactivated.
| |||||||||||
Called by the plugin manager when a plugin or module is activated.
| |||||||||||
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.
| |||||||||||
Get a
ResourceDescriptor of a particular type and name. | |||||||||||
Get a
List of all the descriptors
. | |||||||||||
This method is deprecated.
since 2.5.0 use
getResourceDescriptors() and filter
as required
| |||||||||||
Get a
ResourceLocation of a particular type and name. | |||||||||||
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.
| |||||||||||
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
From interface
com.atlassian.plugin.ModuleDescriptor
| |||||||||||
From interface
com.atlassian.plugin.Resourced
| |||||||||||
From interface
com.atlassian.plugin.StateAware
| |||||||||||
From interface
com.atlassian.plugin.web.descriptors.ConditionalDescriptor
| |||||||||||
From interface
com.atlassian.plugin.web.descriptors.WebFragmentModuleDescriptor
| |||||||||||
From interface
com.atlassian.plugin.web.descriptors.WeightedDescriptor
|
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() |
---|
Called by the plugin manager when the plugin or module is deactivated. This method will only be called if the plugin is deactivated while the application is running: stopping the server will not cause this method to be called on any plugins.
Called by the plugin manager when a plugin or module is activated. Any exceptions thrown should be interpreted as the plugin is unloadable.
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.
Get a ResourceDescriptor
of a particular type and name.
Get a List
of all the descriptors
.
Note: since 2.2 this list must be immutable, previously modifying this list could modify the underlying list.
This method is deprecated.
since 2.5.0 use getResourceDescriptors()
and filter
as required
Get a list of all descriptors
of a particular
type.
Note: since 2.2 this list must be immutable, previously this list was modifiable but modifications would not be reflected in the underlying list.
Get a ResourceLocation
of a particular type and name.
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 |
---|
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.