Package com.atlassian.bamboo.plugin.descriptor

Class BambooEventListenerModuleDescriptor

java.lang.Object

com.atlassian.plugin.descriptors.AbstractModuleDescriptor<BambooEventListener<?>>

com.atlassian.bamboo.plugin.descriptor.AbstractBambooModuleDescriptor<BambooEventListener<?>>

com.atlassian.bamboo.plugin.descriptor.BambooEventListenerModuleDescriptor

All Implemented Interfaces:

com.atlassian.plugin.ModuleDescriptor<BambooEventListener<?>>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.StateAware

public class BambooEventListenerModuleDescriptor
extends AbstractBambooModuleDescriptor<BambooEventListener<?>>

Nested Class Summary

Nested classes/interfaces inherited from class com.atlassian.bamboo.plugin.descriptor.AbstractBambooModuleDescriptor

AbstractBambooModuleDescriptor.ClassNameSource, AbstractBambooModuleDescriptor.ModuleAvailability

Field Summary

Fields inherited from class com.atlassian.bamboo.plugin.descriptor.AbstractBambooModuleDescriptor

CLASS

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

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

Constructor Summary

Constructors

Constructor	Description
BambooEventListenerModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory, com.atlassian.event.api.EventPublisher eventPublisher)

Method Summary

Modifier and Type	Method	Description
void	disabled()
void	enabled()
protected boolean	isMutable()	Whether modules of this descriptor are supposed to be mutated by external components.

Methods inherited from class com.atlassian.bamboo.plugin.descriptor.AbstractBambooModuleDescriptor

getElementAsString, getFreeMarkerResourceLocation, getModule, getVelocityResourceLocation, instantiateClass, instantiateSubmodule, postInit, preInit, prepareSubModuleConfiguration, prepareSubModuleConfiguration

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

assertModuleClassImplements, checkPermissions, destroy, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getModuleClassName, getName, getParams, getPlugin, getPluginKey, getRequiredPermissions, getResourceDescriptor, getResourceDescriptors, getResourceLocation, getScopeKey, hashCode, init, isBroken, isEnabled, isEnabledByDefault, isSystemModule, loadClass, 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

Constructor Details

BambooEventListenerModuleDescriptor

public BambooEventListenerModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory,
 com.atlassian.event.api.EventPublisher eventPublisher)

Method Details

isMutable

protected boolean isMutable()

Description copied from class: AbstractBambooModuleDescriptor

Whether modules of this descriptor are supposed to be mutated by external components. By default this returns true, which means a fresh module instance will be created each time AbstractBambooModuleDescriptor.getModule() is called.

Subclasses that are safe to cache a singleton instance of module throughout the life span of this descriptor can override this method and return false.

Overrides:

isMutable in class AbstractBambooModuleDescriptor<BambooEventListener<?>>

Returns:

true if modules of this descriptor are mutable

enabled

public void enabled()

Specified by:

enabled in interface com.atlassian.plugin.StateAware

Overrides:

enabled in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<BambooEventListener<?>>

disabled

public void disabled()

Specified by:

disabled in interface com.atlassian.plugin.StateAware

Overrides:

disabled in class AbstractBambooModuleDescriptor<BambooEventListener<?>>