com.atlassian.plugin.webresource
Class WebResourceModuleDescriptor

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

All Implemented Interfaces:

com.atlassian.plugin.ModuleDescriptor<Void>, com.atlassian.plugin.Resourced, com.atlassian.plugin.StateAware, ConditionalDescriptor

public class WebResourceModuleDescriptor
extends com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Void>
implements ConditionalDescriptor

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

moduleClass, moduleClassName, moduleFactory, plugin, resources, singleton

Constructor Summary

WebResourceModuleDescriptor(com.atlassian.plugin.hostcontainer.HostContainer hostContainer)

Method Summary

void	disabled()
void	enabled()
Condition	getCondition()
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(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)
boolean	isDisableMinification()
boolean	shouldDisplay()

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

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WebResourceModuleDescriptor

public WebResourceModuleDescriptor(com.atlassian.plugin.hostcontainer.HostContainer hostContainer)

Method Detail

init

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

Specified by:

init in interface com.atlassian.plugin.ModuleDescriptor<Void>

Overrides:

init in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Void>

Throws:

com.atlassian.plugin.PluginParseException

getModule

public Void getModule()

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

Specified by:

getModule in interface com.atlassian.plugin.ModuleDescriptor<Void>

Specified by:

getModule in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Void>

enabled

public void enabled()

Specified by:

enabled in interface com.atlassian.plugin.StateAware

Overrides:

enabled in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Void>

disabled

public void disabled()

Specified by:

disabled in interface com.atlassian.plugin.StateAware

Overrides:

disabled in class com.atlassian.plugin.descriptors.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.

getCondition

public Condition getCondition()

Specified by:

getCondition in interface ConditionalDescriptor

Returns:

The condition to determine if it should be displayed or not

Since:

2.7.0

shouldDisplay

public boolean shouldDisplay()

Returns:

True if this web resource should be displayed based on the optional condition

Since:

2.7.0