com.atlassian.jira.plugin.decorator
Class DecoratorMapperModuleDescriptor

java.lang.Object
  extended by com.atlassian.plugin.descriptors.AbstractModuleDescriptor<com.opensymphony.module.sitemesh.DecoratorMapper>
      extended by com.atlassian.jira.plugin.decorator.DecoratorMapperModuleDescriptor
All Implemented Interfaces:
com.atlassian.plugin.ModuleDescriptor<com.opensymphony.module.sitemesh.DecoratorMapper>, com.atlassian.plugin.Resourced, com.atlassian.plugin.StateAware

public class DecoratorMapperModuleDescriptor
extends com.atlassian.plugin.descriptors.AbstractModuleDescriptor<com.opensymphony.module.sitemesh.DecoratorMapper>

Module descriptor for Sitemesh decorator mappers


Field Summary
 
Fields inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
key, moduleClass, moduleClassName, moduleFactory, name, plugin, resources, singleton
 
Constructor Summary
DecoratorMapperModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory)
           
 
Method Summary
 com.opensymphony.module.sitemesh.DecoratorMapper getDecoratorMapper(com.opensymphony.module.sitemesh.Config config, com.opensymphony.module.sitemesh.DecoratorMapper parent)
          Get the decorator mapper for this module.
 com.opensymphony.module.sitemesh.DecoratorMapper getModule()
          See getDecoratorMapper() for why this returns null
 void init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)
           
 
Methods inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
assertModuleClassImplements, checkPermissions, destroy, disabled, enabled, 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

DecoratorMapperModuleDescriptor

public DecoratorMapperModuleDescriptor(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<com.opensymphony.module.sitemesh.DecoratorMapper>
Overrides:
init in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<com.opensymphony.module.sitemesh.DecoratorMapper>
Throws:
com.atlassian.plugin.PluginParseException

getModule

public com.opensymphony.module.sitemesh.DecoratorMapper getModule()
See getDecoratorMapper() for why this returns null

Specified by:
getModule in interface com.atlassian.plugin.ModuleDescriptor<com.opensymphony.module.sitemesh.DecoratorMapper>
Specified by:
getModule in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<com.opensymphony.module.sitemesh.DecoratorMapper>
Returns:
null

getDecoratorMapper

public com.opensymphony.module.sitemesh.DecoratorMapper getDecoratorMapper(com.opensymphony.module.sitemesh.Config config,
                                                                           com.opensymphony.module.sitemesh.DecoratorMapper parent)
Get the decorator mapper for this module. This method will return an initialised decorator mapper. In order to initialise it though, it needs a parent decorator mapper and configuration, that's why getModule() isn't used.

Parameters:
config - The Sitemesh configuration
parent - The parent decorator mapper
Returns:
An initialised decorator mapper


Copyright © 2002-2013 Atlassian. All Rights Reserved.