com.atlassian.jira.plugin.decorator
Class DecoratorModuleDescriptor

java.lang.Object
  extended by com.atlassian.plugin.descriptors.AbstractModuleDescriptor
      extended by com.atlassian.jira.plugin.decorator.DecoratorModuleDescriptor
All Implemented Interfaces:
com.atlassian.plugin.ModuleDescriptor, com.atlassian.plugin.Resourced, com.atlassian.plugin.StateAware

public class DecoratorModuleDescriptor
extends com.atlassian.plugin.descriptors.AbstractModuleDescriptor

Module descriptor for Sitemesh decorators. This module descriptor has a page, which is the name of a velocity template resource, and a pattern, which is a regular expression matched against the request to see if this decorator should be applied. If more than regular expression matching is required, use a decorator mapper module instead.


Field Summary
 
Fields inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
moduleClassName, moduleFactory, plugin, resources, singleton
 
Constructor Summary
DecoratorModuleDescriptor()
           
 
Method Summary
 java.lang.Object getModule()
           
 java.lang.String getPage()
           
 java.util.regex.Pattern getPattern()
           
 void init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)
           
 
Methods inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
assertModuleClassImplements, destroy, disabled, enabled, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getName, getParams, getPlugin, getPluginKey, getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation, isEnabledByDefault, isSingleton, isSingletonByDefault, isSystemModule, loadClass, loadClass, provideValidationRules, satisfiesMinJavaVersion, setPlugin, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DecoratorModuleDescriptor

public DecoratorModuleDescriptor()
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

getPattern

public java.util.regex.Pattern getPattern()

getPage

public java.lang.String getPage()


Copyright © 2002-2010 Atlassian. All Rights Reserved.