com.atlassian.bamboo.plugin.descriptor
Class BambooEventListenerModuleDescriptor

java.lang.Object
  extended by com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
      extended by com.atlassian.bamboo.plugin.descriptor.AbstractBambooModuleDescriptor<java.lang.Object>
          extended by com.atlassian.bamboo.plugin.descriptor.BambooEventListenerModuleDescriptor
All Implemented Interfaces:
com.atlassian.plugin.ModuleDescriptor<java.lang.Object>, com.atlassian.plugin.Resourced, com.atlassian.plugin.StateAware

public class BambooEventListenerModuleDescriptor
extends AbstractBambooModuleDescriptor<java.lang.Object>


Field Summary
 
Fields inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
moduleClass, moduleClassName, moduleFactory, plugin, resources, singleton
 
Constructor Summary
BambooEventListenerModuleDescriptor(com.atlassian.event.api.EventPublisher eventPublisher)
           
BambooEventListenerModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory, com.atlassian.event.api.EventPublisher eventPublisher)
           
 
Method Summary
 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
getFreeMarkerResourceLocation, getModule, getVelocityResourceLocation, instantiateClass, postInit, preInit
 
Methods inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
assertModuleClassImplements, destroy, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getName, getParams, getPlugin, getPluginKey, getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation, hashCode, init, isEnabledByDefault, isSingleton, isSingletonByDefault, isSystemModule, loadClass, loadClass, provideValidationRules, satisfiesMinJavaVersion, setPlugin, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

BambooEventListenerModuleDescriptor

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

BambooEventListenerModuleDescriptor

public BambooEventListenerModuleDescriptor(com.atlassian.event.api.EventPublisher eventPublisher)
Method Detail

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<java.lang.Object>
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<java.lang.Object>

disabled

public void disabled()
Specified by:
disabled in interface com.atlassian.plugin.StateAware
Overrides:
disabled in class AbstractBambooModuleDescriptor<java.lang.Object>


Copyright © 2013 Atlassian Software Systems Pty Ltd. All Rights Reserved.