com.atlassian.plugin.web.descriptors
Class DefaultWebSectionModuleDescriptor

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

All Implemented Interfaces:

ModuleDescriptor<Void>, Resourced, StateAware, ConditionalDescriptor, ContextAware, WebFragmentModuleDescriptor, WebSectionModuleDescriptor, WeightedDescriptor

public class DefaultWebSectionModuleDescriptor
extends AbstractWebFragmentModuleDescriptor
implements WebSectionModuleDescriptor

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

Field Summary

Fields inherited from class com.atlassian.plugin.web.descriptors.AbstractWebFragmentModuleDescriptor

condition, contextProvider, element, label, params, tooltip, webInterfaceManager, weight

Fields inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

moduleClassName, moduleFactory, plugin, resources, singleton

Fields inherited from interface com.atlassian.plugin.web.descriptors.WebFragmentModuleDescriptor

COMPOSITE_TYPE_AND, COMPOSITE_TYPE_OR

Constructor Summary

DefaultWebSectionModuleDescriptor()

DefaultWebSectionModuleDescriptor(WebInterfaceManager webInterfaceManager)

Method Summary

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, org.dom4j.Element element) Initialise a module given it's parent plugin and the XML element representing the module.

Methods inherited from class com.atlassian.plugin.web.descriptors.AbstractWebFragmentModuleDescriptor

disabled, enabled, getCondition, getContextProvider, getTooltip, getWebLabel, getWebParams, getWeight, makeCondition, makeConditions, makeConditions, makeContextProvider, setWebInterfaceManager

Methods inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

assertModuleClassImplements, destroy, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getName, getParams, getPlugin, getPluginKey, getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation, isEnabledByDefault, isSingleton, isSingletonByDefault, isSystemModule, loadClass, loadClass, provideValidationRules, satisfiesMinJavaVersion, setPlugin, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlassian.plugin.web.descriptors.WebFragmentModuleDescriptor

getCondition, getTooltip, getWebLabel, getWebParams, getWeight

Methods inherited from interface com.atlassian.plugin.ModuleDescriptor

destroy, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getName, getParams, getPlugin, getPluginKey, isEnabledByDefault, isSystemModule, satisfiesMinJavaVersion

Methods inherited from interface com.atlassian.plugin.Resourced

getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation

Methods inherited from interface com.atlassian.plugin.StateAware

disabled, enabled

Methods inherited from interface com.atlassian.plugin.web.descriptors.ContextAware

getContextProvider

Constructor Detail

DefaultWebSectionModuleDescriptor

public DefaultWebSectionModuleDescriptor(WebInterfaceManager webInterfaceManager)

DefaultWebSectionModuleDescriptor

public DefaultWebSectionModuleDescriptor()

Method Detail

init

public void init(Plugin plugin,
                 org.dom4j.Element element)
          throws PluginParseException

Description copied from interface: ModuleDescriptor

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 AbstractModuleDescriptor.enabled() method instead.

Specified by:

init in interface ModuleDescriptor<Void>

Overrides:

init in class AbstractWebFragmentModuleDescriptor

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 - Can be thrown if an error occurs while parsing the XML element.

getLocation

public String getLocation()

Specified by:

getLocation in interface WebSectionModuleDescriptor

getModuleClass

public Class<Void> getModuleClass()

Description copied from interface: ModuleDescriptor

The class of the module this descriptor creates.

Specified by:

getModuleClass in interface ModuleDescriptor<Void>

Overrides:

getModuleClass in class AbstractModuleDescriptor<Void>

Returns:

The class of the module this descriptor creates.

See Also:

ModuleDescriptor.getModule()

getModule

public Void getModule()

Description copied from interface: ModuleDescriptor

The particular module object created by this plugin.

Specified by:

getModule in interface ModuleDescriptor<Void>

Specified by:

getModule in class AbstractModuleDescriptor<Void>

Returns:

The module object created by this plugin.

See Also:

ModuleDescriptor.getModuleClass()