com.atlassian.plugin.webresource
Class WebResourceModuleDescriptor

java.lang.Object
  com.atlassian.plugin.descriptors.AbstractModuleDescriptor<java.lang.Void>
      com.atlassian.plugin.webresource.WebResourceModuleDescriptor

All Implemented Interfaces:

ModuleDescriptor<java.lang.Void>, Resourced, StateAware

public class WebResourceModuleDescriptor
extends AbstractModuleDescriptor<java.lang.Void>

A way of linking to web 'resources', such as javascript or css. This allows us to include resources once on any given page, as well as ensuring that plugins can declare resources, even if they are included at the bottom of a page.

Field Summary

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

plugin, resources, singleton

Constructor Summary

WebResourceModuleDescriptor()

Method Summary

java.util.List<java.lang.String>	getDependencies() Returns a list of dependencies on other web resources.
java.lang.Void	getModule() As this descriptor just handles resources, you should never call this
void	init(Plugin plugin, org.dom4j.Element element)

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

assertModuleClassImplements, destroy, disabled, enabled, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, 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

Constructor Detail

WebResourceModuleDescriptor

public WebResourceModuleDescriptor()

Method Detail

init

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

Specified by:

init in interface ModuleDescriptor<java.lang.Void>

Overrides:

init in class AbstractModuleDescriptor<java.lang.Void>

Throws:

PluginParseException

getModule

public java.lang.Void getModule()

As this descriptor just handles resources, you should never call this

Specified by:

getModule in interface ModuleDescriptor<java.lang.Void>

Specified by:

getModule in class AbstractModuleDescriptor<java.lang.Void>

getDependencies

public java.util.List<java.lang.String> getDependencies()

Returns a list of dependencies on other web resources.

Returns:

a list of module complete keys