com.atlassian.confluence.plugin.descriptor
Class VelocityContextItemModuleDescriptor

java.lang.Object
  com.atlassian.plugin.descriptors.AbstractModuleDescriptor
      com.atlassian.confluence.plugin.descriptor.VelocityContextItemModuleDescriptor

All Implemented Interfaces:

ModuleDescriptor, Resourced

public class VelocityContextItemModuleDescriptor
extends AbstractModuleDescriptor

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

plugin, resources, singleton

Constructor Summary

VelocityContextItemModuleDescriptor()

Method Summary

String	getContextKey()
Object	getModule()
void	init(Plugin plugin, org.dom4j.Element element)
protected boolean	isSingletonByDefault()

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

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

VelocityContextItemModuleDescriptor

public VelocityContextItemModuleDescriptor()

Method Detail

init

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

Specified by:

init in interface ModuleDescriptor

Overrides:

init in class AbstractModuleDescriptor

Throws:

PluginParseException

getModule

public Object getModule()

Specified by:

getModule in interface ModuleDescriptor

Specified by:

getModule in class AbstractModuleDescriptor

isSingletonByDefault

protected boolean isSingletonByDefault()

Overrides:

isSingletonByDefault in class AbstractModuleDescriptor

getContextKey

public String getContextKey()