com.atlassian.plugin.schema.impl

Class DescribedModuleTypeModuleDescriptor

java.lang.Object

com.atlassian.plugin.descriptors.AbstractModuleDescriptor<DescribedModuleDescriptorFactory>

com.atlassian.plugin.schema.impl.DescribedModuleTypeModuleDescriptor

All Implemented Interfaces:

com.atlassian.plugin.ModuleDescriptor<DescribedModuleDescriptorFactory>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.StateAware

public final class DescribedModuleTypeModuleDescriptor
extends com.atlassian.plugin.descriptors.AbstractModuleDescriptor<DescribedModuleDescriptorFactory>

Descriptor that allows described module descriptor factories to be configured in XML. Main value is the ability to reuse the name and description of the module descriptor configuration.

Field Summary

Fields inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

key, moduleClass, moduleClassName, moduleFactory, name, plugin, resources, singleton

Constructor Summary

Constructors

Constructor and Description
DescribedModuleTypeModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory)

Method Summary

Modifier and Type	Method and Description
void	enabled()
DescribedModuleDescriptorFactory	getModule()
static String	getOptionalAttribute(org.dom4j.Element e, String name, Object defaultValue)
void	init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)

Methods inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

assertModuleClassImplements, checkPermissions, destroy, destroy, disabled, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getModuleClassName, getName, getParams, getPlugin, getPluginKey, getRequiredPermissions, getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation, getScopeKey, hashCode, isBroken, isEnabled, isEnabledByDefault, isSingleton, isSingletonByDefault, isSystemModule, loadClass, loadClass, provideValidationRules, satisfiesMinJavaVersion, setBroken, setPlugin, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribedModuleTypeModuleDescriptor

public DescribedModuleTypeModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory)

Method Detail

init

public void init(@Nonnull
                 com.atlassian.plugin.Plugin plugin,
                 @Nonnull
                 org.dom4j.Element element)
          throws com.atlassian.plugin.PluginParseException

Specified by:

init in interface com.atlassian.plugin.ModuleDescriptor<DescribedModuleDescriptorFactory>

Overrides:

init in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<DescribedModuleDescriptorFactory>

Throws:

com.atlassian.plugin.PluginParseException

enabled

public void enabled()

Specified by:

enabled in interface com.atlassian.plugin.StateAware

Overrides:

enabled in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<DescribedModuleDescriptorFactory>

getModule

public DescribedModuleDescriptorFactory getModule()

Specified by:

getModule in interface com.atlassian.plugin.ModuleDescriptor<DescribedModuleDescriptorFactory>

Specified by:

getModule in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<DescribedModuleDescriptorFactory>

getOptionalAttribute

public static String getOptionalAttribute(org.dom4j.Element e,
                                          String name,
                                          Object defaultValue)