com.atlassian.plugin.webresource
Class WebResourceModuleDescriptor

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

All Implemented Interfaces:

ModuleDescriptor<Void>, Resourced, StateAware

public class WebResourceModuleDescriptor
extends AbstractModuleDescriptor<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

moduleClassName, moduleFactory, plugin, resources, singleton

Constructor Summary

WebResourceModuleDescriptor()

Method Summary

Set<String>	getContexts() Returns the web resource contexts this resource is associated with.
List<String>	getDependencies() Returns a list of dependencies on other web resources.
Void	getModule() As this descriptor just handles resources, you should never call this
List<com.atlassian.plugin.webresource.WebResourceTransformation>	getTransformations()
void	init(Plugin plugin, org.dom4j.Element element)
boolean	isDisableMinification()

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<Void>

Overrides:

init in class AbstractModuleDescriptor<Void>

Throws:

PluginParseException

getModule

public Void getModule()

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

Specified by:

getModule in interface ModuleDescriptor<Void>

Specified by:

getModule in class AbstractModuleDescriptor<Void>

getContexts

public Set<String> getContexts()

Returns the web resource contexts this resource is associated with.

Returns:

the web resource contexts this resource is associated with.

Since:

2.5.0

getDependencies

public List<String> getDependencies()

Returns a list of dependencies on other web resources.

Returns:

a list of module complete keys

getTransformations

public List<com.atlassian.plugin.webresource.WebResourceTransformation> getTransformations()

isDisableMinification

public boolean isDisableMinification()

Returns:

true if resource minification should be skipped, false otherwise.