|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ModuleDescriptor<T>
Method Summary | |
---|---|
void |
destroy(Plugin plugin)
Override this if your plugin needs to clean up when it's been removed. |
java.lang.String |
getCompleteKey()
The complete key for this module, including the plugin key. |
java.lang.String |
getDescription()
A simple description of this descriptor. |
java.lang.String |
getDescriptionKey()
Key used to override getDescription() when using internationalisation. |
java.lang.String |
getI18nNameKey()
Key used to override getName() when using internationalisation. |
java.lang.String |
getKey()
The key for this module, unique within the plugin. |
java.lang.Float |
getMinJavaVersion()
|
T |
getModule()
The particular module object created by this plugin. |
java.lang.Class<T> |
getModuleClass()
The class of the module this descriptor creates. |
java.lang.String |
getName()
A simple string name for this descriptor. |
java.util.Map<java.lang.String,java.lang.String> |
getParams()
|
Plugin |
getPlugin()
|
java.lang.String |
getPluginKey()
The plugin key for this module, derived from the complete key. |
void |
init(Plugin plugin,
org.dom4j.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. |
Methods inherited from interface com.atlassian.plugin.Resourced |
---|
getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation |
Method Detail |
---|
java.lang.String getCompleteKey()
Format is plugin.key:module.key
getKey()
,
getPluginKey()
java.lang.String getPluginKey()
getKey()
,
getCompleteKey()
java.lang.String getKey()
getCompleteKey()
,
getPluginKey()
java.lang.String getName()
java.lang.String getDescription()
java.lang.Class<T> getModuleClass()
getModule()
T getModule()
getModuleClass()
void init(Plugin plugin, org.dom4j.Element element) throws PluginParseException
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 AbstractModuleDescriptor.enabled()
method instead.
plugin
- The plugin that the module belongs to.element
- XML element representing the module.
PluginParseException
- Can be thrown if an error occurs while parsing the XML element.boolean isEnabledByDefault()
true
if this plugin module is enabled by default.boolean isSystemModule()
true
if this plugin module is a "system" plugin that shouldn't be made visible/disableable to the user.void destroy(Plugin plugin)
plugin
- TODO: The plugin parameter is redundant. The ModuleDescriptor must know its parent plugin in order to implement getPlugin()java.lang.Float getMinJavaVersion()
boolean satisfiesMinJavaVersion()
java.util.Map<java.lang.String,java.lang.String> getParams()
java.lang.String getI18nNameKey()
getName()
when using internationalisation.
java.lang.String getDescriptionKey()
getDescription()
when using internationalisation.
Plugin getPlugin()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |