DecoratorModuleDescriptor (Atlassian Bamboo 9.6.1 API)

java.lang.Object
- com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
- - com.atlassian.bamboo.plugin.descriptor.AbstractBambooModuleDescriptor
  - - com.atlassian.bamboo.plugin.descriptor.DecoratorModuleDescriptor

All Implemented Interfaces:

com.atlassian.plugin.ModuleDescriptor, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.StateAware
```
public class DecoratorModuleDescriptor
extends AbstractBambooModuleDescriptor
```
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
  key, moduleClass, moduleClassName, moduleFactory, name, plugin, resources

Constructor Summary

Constructors
Constructor Description

DecoratorModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`@Nullable Object`	`getModule()`
`@NotNull String`	`getPage()`
`@Nullable Pattern`	`getPattern()`
`void`	`init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)`

Methods inherited from class com.atlassian.bamboo.plugin.descriptor.AbstractBambooModuleDescriptor
disabled, getElementAsString, getFreeMarkerResourceLocation, getVelocityResourceLocation, instantiateClass, instantiateSubmodule, isMutable, postInit, preInit

Methods inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
assertModuleClassImplements, checkPermissions, destroy, enabled, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getModuleClassName, getName, getParams, getPlugin, getPluginKey, getRequiredPermissions, getResourceDescriptor, getResourceDescriptors, getResourceLocation, getScopeKey, hashCode, isBroken, isEnabled, isEnabledByDefault, isSystemModule, loadClass, provideValidationRules, satisfiesMinJavaVersion, setBroken, setPlugin, toString, validate

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlassian.plugin.ModuleDescriptor
getDisplayName, init

- Constructor Detail
  - DecoratorModuleDescriptor
```
public DecoratorModuleDescriptor(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
    
    Overrides:
    
    init in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
    
    Throws:
    
    com.atlassian.plugin.PluginParseException
  - getModule
```
@Nullable
public @Nullable Object getModule()
```
    Specified by:
    
    getModule in interface com.atlassian.plugin.ModuleDescriptor
    
    Overrides:
    
    getModule in class AbstractBambooModuleDescriptor
  - getPattern
```
@Nullable
public @Nullable Pattern getPattern()
```
  - getPage
```
@NotNull
public @NotNull String getPage()
```