com.atlassian.confluence.plugin.descriptor

Class VelocityContextItemModuleDescriptor

java.lang.Object

com.atlassian.plugin.descriptors.AbstractModuleDescriptor<java.lang.Object>

com.atlassian.confluence.plugin.descriptor.VelocityContextItemModuleDescriptor

All Implemented Interfaces:

PluginModuleFactory<java.lang.Object>, com.atlassian.plugin.ModuleDescriptor<java.lang.Object>, com.atlassian.plugin.Resourced, com.atlassian.plugin.StateAware

public class VelocityContextItemModuleDescriptor
extends com.atlassian.plugin.descriptors.AbstractModuleDescriptor<java.lang.Object>
implements PluginModuleFactory<java.lang.Object>

A module descriptor to add items to the Velocity contexts used everywhere.

Note: Items must have a zero argument constructor.

Field Summary

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

key, moduleClass, moduleClassName, moduleFactory, name, plugin, resources, singleton

Constructor Summary

Constructors

Constructor and Description
VelocityContextItemModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	createModule()
void	disabled()
void	enabled()
java.lang.String	getContextKey()
java.lang.Object	getModule()
void	init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)

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

assertModuleClassImplements, checkPermissions, destroy, destroy, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getModuleClassName, getName, getParams, getPlugin, getPluginKey, getRequiredPermissions, 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

VelocityContextItemModuleDescriptor

public VelocityContextItemModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory)

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<java.lang.Object>

Overrides:

init in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<java.lang.Object>

Throws:

com.atlassian.plugin.PluginParseException

getModule

public java.lang.Object getModule()

Specified by:

getModule in interface com.atlassian.plugin.ModuleDescriptor<java.lang.Object>

Specified by:

getModule in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<java.lang.Object>

enabled

public void enabled()

Specified by:

enabled in interface com.atlassian.plugin.StateAware

Overrides:

enabled in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<java.lang.Object>

disabled

public void disabled()

Specified by:

disabled in interface com.atlassian.plugin.StateAware

Overrides:

disabled in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<java.lang.Object>

createModule

public java.lang.Object createModule()

Specified by:

createModule in interface PluginModuleFactory<java.lang.Object>

getContextKey

public java.lang.String getContextKey()