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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

DefaultWebItemModuleDescriptor, DefaultWebPanelModuleDescriptor, DefaultWebSectionModuleDescriptor

public abstract class AbstractWebFragmentModuleDescriptor<T>
extends AbstractModuleDescriptor<T>
implements StateAware, WebFragmentModuleDescriptor<T>

An abstract convenience class for web fragment descriptors.

Field Summary

protected Condition	condition
protected ContextProvider	contextProvider
protected org.dom4j.Element	element
protected DefaultWebLabel	label
protected WebParam	params
protected DefaultWebLabel	tooltip
protected WebInterfaceManager	webInterfaceManager
protected int	weight

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

moduleClass, moduleClassName, moduleFactory, plugin, resources, singleton

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

COMPOSITE_TYPE_AND, COMPOSITE_TYPE_OR

Constructor Summary

	AbstractWebFragmentModuleDescriptor()
	AbstractWebFragmentModuleDescriptor(ModuleFactory moduleClassFactory, WebInterfaceManager webInterfaceManager)
protected	AbstractWebFragmentModuleDescriptor(WebInterfaceManager webInterfaceManager)

Method Summary

void	disabled() Disables the module descriptor.
void	enabled() Enables the descriptor by loading the module class.
boolean	equals(Object obj) Compares the specified object with this module descriptor for equality.
Condition	getCondition()
ContextProvider	getContextProvider() Returns the ContextProvider that augments the context used to render a web module.
WebLabel	getTooltip()
WebLabel	getWebLabel()
WebParam	getWebParams()
int	getWeight()
int	hashCode() Returns the hash code value for this module descriptor.
void	init(Plugin plugin, org.dom4j.Element element) Initialise a module given it's parent plugin and the XML element representing the module.
protected Condition	makeCondition(org.dom4j.Element element)
protected Condition	makeConditions(org.dom4j.Element element, int type) Create a condition for when this web fragment should be displayed
protected Condition	makeConditions(List elements, int type)
protected ContextProvider	makeContextProvider(org.dom4j.Element element)
void	setWebInterfaceManager(WebInterfaceManager webInterfaceManager)

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

assertModuleClassImplements, destroy, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModule, 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, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlassian.plugin.ModuleDescriptor

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

Methods inherited from interface com.atlassian.plugin.Resourced

getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation

Field Detail

webInterfaceManager

protected WebInterfaceManager webInterfaceManager

element

protected org.dom4j.Element element

weight

protected int weight

condition

protected Condition condition

contextProvider

protected ContextProvider contextProvider

label

protected DefaultWebLabel label

tooltip

protected DefaultWebLabel tooltip

params

protected WebParam params

Constructor Detail

AbstractWebFragmentModuleDescriptor

protected AbstractWebFragmentModuleDescriptor(WebInterfaceManager webInterfaceManager)

AbstractWebFragmentModuleDescriptor

public AbstractWebFragmentModuleDescriptor()

AbstractWebFragmentModuleDescriptor

public AbstractWebFragmentModuleDescriptor(ModuleFactory moduleClassFactory,
                                           WebInterfaceManager webInterfaceManager)

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

Overrides:

init in class AbstractModuleDescriptor<T>

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.

makeConditions

protected Condition makeConditions(org.dom4j.Element element,
                                   int type)
                            throws PluginParseException

Create a condition for when this web fragment should be displayed

Parameters:

element - Element of web-section or web-item

type - logical operator type

Throws:

PluginParseException

makeConditions

protected Condition makeConditions(List elements,
                                   int type)
                            throws PluginParseException

Throws:

PluginParseException

makeCondition

protected Condition makeCondition(org.dom4j.Element element)
                           throws PluginParseException

Throws:

PluginParseException

makeContextProvider

protected ContextProvider makeContextProvider(org.dom4j.Element element)
                                       throws PluginParseException

Throws:

PluginParseException

enabled

public void enabled()

Description copied from class: AbstractModuleDescriptor

Enables the descriptor by loading the module class. Classes overriding this method MUST call super.enabled() before their own enabling code.

Specified by:

enabled in interface StateAware

Overrides:

enabled in class AbstractModuleDescriptor<T>

disabled

public void disabled()

Description copied from class: AbstractModuleDescriptor

Disables the module descriptor. Classes overriding this method MUST call super.disabled() after their own disabling code.

Specified by:

disabled in interface StateAware

Overrides:

disabled in class AbstractModuleDescriptor<T>

getWeight

public int getWeight()

Specified by:

getWeight in interface WebFragmentModuleDescriptor<T>

Specified by:

getWeight in interface WeightedDescriptor

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>

equals

public boolean equals(Object obj)

Description copied from interface: ModuleDescriptor

Compares the specified object with this module descriptor for equality.

Returns true if the given object is also a module descriptor and the two descriptors have the same "complete key" as determined by ModuleDescriptor.getCompleteKey().

This ensures that the equals method works properly across different implementations of the ModuleDescriptor interface.

Specified by:

equals in interface ModuleDescriptor<T>

Overrides:

equals in class AbstractModuleDescriptor<T>

Parameters:

obj - object to be compared for equality with this module descriptor.

Returns:

true if the specified object is equal to this module descriptor.

hashCode

public int hashCode()

Description copied from interface: ModuleDescriptor

Returns the hash code value for this module descriptor. The hash code of a module descriptor d is defined to be:

     getCompleteKey() == null ? 0 : getCompleteKey().hashCode()
 

This ensures that d1.equals(d2) implies that d1.hashCode()==d2.hashCode() for any two Module Descriptors d1 and d2, as required by the general contract of Object.hashCode.

Specified by:

hashCode in interface ModuleDescriptor<T>

Overrides:

hashCode in class AbstractModuleDescriptor<T>

Returns:

the hash code value for this module descriptor.

See Also:

Object.hashCode(), Object.equals(Object), ModuleDescriptor.equals(Object)