|
final
void
|
assertModuleClassImplements(Class<T> requiredModuleClazz)
Check that the module class of this descriptor implements a given
interface, or extends a given class.
|
|
void
|
destroy(Plugin plugin)
Override this if your plugin needs to clean up when it's been removed.
|
|
void
|
disabled()
Disables the module descriptor.
|
|
void
|
enabled()
Enables the descriptor by loading the module class.
|
|
boolean
|
equals(Object obj)
|
|
String
|
getCompleteKey()
The complete key for this module, including the plugin key.
|
|
String
|
getDescription()
A simple description of this descriptor.
|
|
String
|
getDescriptionKey()
|
|
String
|
getI18nNameKey()
Key used to override getName() when using internationalisation. |
|
String
|
getKey()
The key for this module, unique within the plugin.
|
|
Float
|
getMinJavaVersion()
|
|
abstract
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<String, String>
|
getParams()
|
|
Plugin
|
getPlugin()
|
|
String
|
getPluginKey()
The plugin key for this module, derived from the complete key.
|
|
ResourceDescriptor
|
getResourceDescriptor(String type, String name)
|
|
List<ResourceDescriptor>
|
getResourceDescriptors()
|
|
List<ResourceDescriptor>
|
getResourceDescriptors(String type)
|
|
ResourceLocation
|
getResourceLocation(String type, String name)
|
|
int
|
hashCode()
|
|
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.
|
|
@Deprecated
boolean
|
isSingleton()
This method is deprecated.
Since 2.2.0
|
|
@Deprecated
boolean
|
isSingletonByDefault()
This method is deprecated.
Since 2.2.0
|
|
boolean
|
isSystemModule()
Whether or not this plugin module is a "system" plugin that shouldn't be
made visible/disableable to the user.
|
|
void
|
loadClass(Plugin plugin, String clazz)
Loads the module class that this descriptor provides, and will not
necessarily be the implementation class.
|
|
@Deprecated
void
|
loadClass(Plugin plugin, Element element)
|
|
void
|
provideValidationRules(ValidationPattern pattern)
Provides validation rules for the pattern
|
|
boolean
|
satisfiesMinJavaVersion()
If a min java version has been specified this will return true if the
running jvm is >= to the specified version.
|
|
void
|
setPlugin(Plugin plugin)
Sets the plugin for the ModuleDescriptor
|
|
String
|
toString()
|
From class
com.atlassian.plugin.descriptors.AbstractModuleDescriptor