com.atlassian.plugin.eventlistener.descriptors

Class EventListenerModuleDescriptor

java.lang.Object

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

com.atlassian.plugin.eventlistener.descriptors.EventListenerModuleDescriptor

All Implemented Interfaces:

ModuleDescriptor<Object>, Resourced, ScopeAware, StateAware

public class EventListenerModuleDescriptor
extends AbstractModuleDescriptor<Object>

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
EventListenerModuleDescriptor(ModuleFactory moduleFactory, com.atlassian.event.api.EventPublisher eventPublisher)

Method Summary

Modifier and Type	Method and Description
void	disabled() Disables the module descriptor.
void	enabled() Enables the descriptor by loading the module class.
Object	getModule()
void	init(Plugin plugin, org.dom4j.Element element)

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

assertModuleClassImplements, checkPermissions, destroy, destroy, 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

EventListenerModuleDescriptor

public EventListenerModuleDescriptor(ModuleFactory moduleFactory,
                                     com.atlassian.event.api.EventPublisher eventPublisher)

Method Detail

init

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

Specified by:

init in interface ModuleDescriptor<Object>

Overrides:

init in class AbstractModuleDescriptor<Object>

Throws:

PluginParseException

getModule

public Object getModule()

Specified by:

getModule in interface ModuleDescriptor<Object>

Specified by:

getModule in class AbstractModuleDescriptor<Object>

enabled

public void enabled()

Description copied from class: AbstractModuleDescriptor

Enables the descriptor by loading the module class. Classes overriding this method MUST call super.enabled() before their own enabling code.

Specified by:

enabled in interface StateAware

Overrides:

enabled in class AbstractModuleDescriptor<Object>

disabled

public void disabled()

Description copied from class: AbstractModuleDescriptor

Disables the module descriptor. Classes overriding this method MUST call super.disabled() after their own disabling code.

Specified by:

disabled in interface StateAware

Overrides:

disabled in class AbstractModuleDescriptor<Object>