com.atlassian.confluence.plugin.descriptor
Class VelocityContextItemModuleDescriptor

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

All Implemented Interfaces:

com.atlassian.plugin.ModuleDescriptor, com.atlassian.plugin.Resourced

public class VelocityContextItemModuleDescriptor
extends com.atlassian.plugin.descriptors.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

java.lang.String	getContextKey()
java.lang.Object	getModule()
void	init(com.atlassian.plugin.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(com.atlassian.plugin.Plugin plugin,
                 org.dom4j.Element element)
          throws com.atlassian.plugin.PluginParseException

Specified by:

init in interface com.atlassian.plugin.ModuleDescriptor

Overrides:

init in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

Throws:

com.atlassian.plugin.PluginParseException

getModule

public java.lang.Object getModule()

Specified by:

getModule in interface com.atlassian.plugin.ModuleDescriptor

Specified by:

getModule in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

isSingletonByDefault

protected boolean isSingletonByDefault()

Overrides:

isSingletonByDefault in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

getContextKey

public java.lang.String getContextKey()