com.atlassian.plugin.web.descriptors
Class DefaultAbstractWebFragmentModuleDescriptor<T>

java.lang.Object
  com.atlassian.plugin.web.descriptors.DefaultAbstractWebFragmentModuleDescriptor<T>

All Implemented Interfaces:

ModuleDescriptor<T>, Resourced, StateAware, ConditionalDescriptor, ContextAware, WebFragmentModuleDescriptor<T>, WeightedDescriptor

public class DefaultAbstractWebFragmentModuleDescriptor<T>
extends Object
implements StateAware, WebFragmentModuleDescriptor<T>

Wrapper for WebFragmentModuleDescriptor, so that it could be extended by application specific wrappers to provide additional methods.

Field Summary

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

COMPOSITE_TYPE_AND, COMPOSITE_TYPE_OR

Constructor Summary

DefaultAbstractWebFragmentModuleDescriptor(WebFragmentModuleDescriptor<T> abstractDescriptor)

Method Summary

void	destroy(Plugin plugin)
void	disabled()
void	enabled()
String	getCompleteKey()
Condition	getCondition()
ContextProvider	getContextProvider() Returns the ContextProvider that augments the context used to render a web module.
protected WebFragmentModuleDescriptor	getDecoratedDescriptor()
String	getDescription()
String	getDescriptionKey()
String	getI18nNameKey()
String	getKey()
Float	getMinJavaVersion()
T	getModule()
Class<T>	getModuleClass()
String	getName()
Map<String,String>	getParams()
Plugin	getPlugin()
String	getPluginKey()
ResourceDescriptor	getResourceDescriptor(String type, String name)
List<ResourceDescriptor>	getResourceDescriptors()
List<ResourceDescriptor>	getResourceDescriptors(String type) Deprecated. since 2.5.0 use getResourceDescriptors() and filter as required
ResourceLocation	getResourceLocation(String type, String name)
WebLabel	getTooltip()
WebLabel	getWebLabel()
WebParam	getWebParams()
int	getWeight()
void	init(Plugin plugin, org.dom4j.Element element)
boolean	isEnabledByDefault()
boolean	isSystemModule()
boolean	satisfiesMinJavaVersion()
void	setWebInterfaceManager(WebInterfaceManager webInterfaceManager)
String	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.ModuleDescriptor

equals, hashCode

Constructor Detail

DefaultAbstractWebFragmentModuleDescriptor

public DefaultAbstractWebFragmentModuleDescriptor(WebFragmentModuleDescriptor<T> abstractDescriptor)

Method Detail

enabled

public void enabled()

Specified by:

enabled in interface StateAware

disabled

public void disabled()

Specified by:

disabled in interface StateAware

getDecoratedDescriptor

protected WebFragmentModuleDescriptor getDecoratedDescriptor()

getWeight

public int getWeight()

Specified by:

getWeight in interface WebFragmentModuleDescriptor<T>

Specified by:

getWeight in interface WeightedDescriptor

getKey

public String getKey()

Specified by:

getKey in interface ModuleDescriptor<T>

getModule

public T getModule()

Specified by:

getModule in interface ModuleDescriptor<T>

getI18nNameKey

public String getI18nNameKey()

Specified by:

getI18nNameKey in interface ModuleDescriptor<T>

getDescriptionKey

public String getDescriptionKey()

Specified by:

getDescriptionKey in interface ModuleDescriptor<T>

getPlugin

public Plugin getPlugin()

Specified by:

getPlugin in interface ModuleDescriptor<T>

getWebLabel

public WebLabel getWebLabel()

Specified by:

getWebLabel in interface WebFragmentModuleDescriptor<T>

getTooltip

public WebLabel getTooltip()

Specified by:

getTooltip in interface WebFragmentModuleDescriptor<T>

setWebInterfaceManager

public void setWebInterfaceManager(WebInterfaceManager webInterfaceManager)

getCondition

public Condition getCondition()

Specified by:

getCondition in interface ConditionalDescriptor

Specified by:

getCondition in interface WebFragmentModuleDescriptor<T>

getContextProvider

public ContextProvider getContextProvider()

Description copied from interface: ContextAware

Returns the ContextProvider that augments the context used to render a web module.

Specified by:

getContextProvider in interface ContextAware

getWebParams

public WebParam getWebParams()

Specified by:

getWebParams in interface WebFragmentModuleDescriptor<T>

getCompleteKey

public String getCompleteKey()

Specified by:

getCompleteKey in interface ModuleDescriptor<T>

getPluginKey

public String getPluginKey()

Specified by:

getPluginKey in interface ModuleDescriptor<T>

getName

public String getName()

Specified by:

getName in interface ModuleDescriptor<T>

getDescription

public String getDescription()

Specified by:

getDescription in interface ModuleDescriptor<T>

getModuleClass

public Class<T> getModuleClass()

Specified by:

getModuleClass in interface ModuleDescriptor<T>

init

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

Specified by:

init in interface ModuleDescriptor<T>

Throws:

PluginParseException

isEnabledByDefault

public boolean isEnabledByDefault()

Specified by:

isEnabledByDefault in interface ModuleDescriptor<T>

isSystemModule

public boolean isSystemModule()

Specified by:

isSystemModule in interface ModuleDescriptor<T>

destroy

public void destroy(Plugin plugin)

Specified by:

destroy in interface ModuleDescriptor<T>

getMinJavaVersion

public Float getMinJavaVersion()

Specified by:

getMinJavaVersion in interface ModuleDescriptor<T>

satisfiesMinJavaVersion

public boolean satisfiesMinJavaVersion()

Specified by:

satisfiesMinJavaVersion in interface ModuleDescriptor<T>

getParams

public Map<String,String> getParams()

Specified by:

getParams in interface ModuleDescriptor<T>

getResourceDescriptors

public List<ResourceDescriptor> getResourceDescriptors()

Specified by:

getResourceDescriptors in interface Resourced

getResourceDescriptors

@Deprecated
public List<ResourceDescriptor> getResourceDescriptors(String type)

Deprecated. since 2.5.0 use getResourceDescriptors() and filter as required

Specified by:

getResourceDescriptors in interface Resourced

getResourceLocation

public ResourceLocation getResourceLocation(String type,
                                            String name)

Specified by:

getResourceLocation in interface Resourced

getResourceDescriptor

public ResourceDescriptor getResourceDescriptor(String type,
                                                String name)

Specified by:

getResourceDescriptor in interface Resourced

toString

public String toString()

Overrides:

toString in class Object