com.atlassian.confluence.plugin.descriptor
Class VelocityContextItemModuleDescriptor

java.lang.Object
  extended by com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Object>
      extended by com.atlassian.confluence.plugin.descriptor.VelocityContextItemModuleDescriptor
All Implemented Interfaces:
PluginModuleFactory<Object>, com.atlassian.plugin.ModuleDescriptor<Object>, com.atlassian.plugin.Resourced, com.atlassian.plugin.StateAware

public class VelocityContextItemModuleDescriptor
extends com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Object>
implements PluginModuleFactory<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
moduleClass, moduleClassName, moduleFactory, plugin, resources, singleton
 
Constructor Summary
VelocityContextItemModuleDescriptor()
           
 
Method Summary
 Object createModule()
           
 void disabled()
           
 void enabled()
           
 String getContextKey()
           
 Object getModule()
           
 void init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)
           
 
Methods inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
assertModuleClassImplements, destroy, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getName, getParams, getPlugin, getPluginKey, 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()
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<Object>
Overrides:
init in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Object>
Throws:
com.atlassian.plugin.PluginParseException

getModule

public Object getModule()
Specified by:
getModule in interface com.atlassian.plugin.ModuleDescriptor<Object>
Specified by:
getModule in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Object>

enabled

public void enabled()
Specified by:
enabled in interface com.atlassian.plugin.StateAware
Overrides:
enabled in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Object>

disabled

public void disabled()
Specified by:
disabled in interface com.atlassian.plugin.StateAware
Overrides:
disabled in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Object>

createModule

public Object createModule()
Specified by:
createModule in interface PluginModuleFactory<Object>

getContextKey

public String getContextKey()


Copyright © 2003-2013 Atlassian. All Rights Reserved.