WebFragmentModuleDescriptor

implements ModuleDescriptor<T> StateAware ConditionalDescriptor WeightedDescriptor

com.atlassian.plugin.web.descriptors.WebFragmentModuleDescriptor

Known Indirect Subclasses

Class Overview

A convenience interface for web fragment descriptors

Constants
int	COMPOSITE_TYPE_AND	This constant is deprecated. As of 2.5.0, use ConditionElementParser.CompositeType.AND
int	COMPOSITE_TYPE_OR	This constant is deprecated. As of 2.5.0, use ConditionElementParser.CompositeType#OR

Inherited Methods

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