public class

DefaultWebSectionModuleDescriptor

extends AbstractWebFragmentModuleDescriptor
implements WebSectionModuleDescriptor

java.lang.Object
↳	com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
	↳	com.atlassian.plugin.web.descriptors.AbstractWebFragmentModuleDescriptor
		↳	com.atlassian.plugin.web.descriptors.DefaultWebSectionModuleDescriptor

Class Overview

Represents a web section - that is a collection of web items.

Summary

[Expand]

Inherited Constants

From interface com.atlassian.plugin.web.descriptors.WebFragmentModuleDescriptor

[Expand]

Inherited Fields

From class com.atlassian.plugin.web.descriptors.AbstractWebFragmentModuleDescriptor

From class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

Public Constructors
	DefaultWebSectionModuleDescriptor(WebInterfaceManager webInterfaceManager)
	DefaultWebSectionModuleDescriptor()

Public Methods
String	getLocation()
Void	getModule() The particular module object created by this plugin.
Class<Void>	getModuleClass() The class of the module this descriptor creates.
void	init(Plugin plugin, Element element) Initialise a module given it's parent plugin and the XML element representing the module.

[Expand]

Inherited Methods

From class com.atlassian.plugin.web.descriptors.AbstractWebFragmentModuleDescriptor

From class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

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.
String	getCompleteKey() The complete key for this module, including the plugin key.
String	getDescription() A simple description of this descriptor.
String	getDescriptionKey() Key used to override `getDescription()` when using internationalisation.
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) Get a `ResourceDescriptor` of a particular type and name.
List<ResourceDescriptor>	getResourceDescriptors() Get a List of all the `descriptors` .
List<ResourceDescriptor>	getResourceDescriptors(String type) Get a list of all `descriptors` of a particular type.
ResourceLocation	getResourceLocation(String type, String name) Get a `ResourceLocation` of a particular type and name.
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.
boolean	isSingleton() This method is deprecated. Since 2.2.0
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.
void	loadClass(Plugin plugin, Element element) This method is deprecated. Since 2.1.0, use `loadClass(Plugin, String)` instead
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 java.lang.Object

From interface com.atlassian.plugin.ModuleDescriptor

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.

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.ContextAware

From interface com.atlassian.plugin.web.descriptors.WebFragmentModuleDescriptor

From interface com.atlassian.plugin.web.descriptors.WebSectionModuleDescriptor

From interface com.atlassian.plugin.web.descriptors.WeightedDescriptor

Public Constructors

public DefaultWebSectionModuleDescriptor (WebInterfaceManager webInterfaceManager)

public DefaultWebSectionModuleDescriptor ()

Public Methods

public String getLocation ()

public Void getModule ()

The particular module object created by this plugin.

Returns

The module object created by this plugin.

public Class<Void> getModuleClass ()

The class of the module this descriptor creates.

Returns

The class of the module this descriptor creates.

public void init (Plugin plugin, Element element)

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.

Parameters

plugin	The plugin that the module belongs to. Must not be null.
element	XML element representing the module. Must not be null.

Throws

PluginParseException

Interfaces

Classes

DefaultWebSectionModuleDescriptor

Class Overview

Summary

Public Constructors

public DefaultWebSectionModuleDescriptor (WebInterfaceManager webInterfaceManager)

public DefaultWebSectionModuleDescriptor ()

Public Methods

public String getLocation ()

public Void getModule ()

Returns

public Class<Void> getModuleClass ()

Returns

public void init (Plugin plugin, Element element)

Parameters

Throws