Uses of Interface
com.atlassian.plugin.ModuleDescriptor

Packages that use ModuleDescriptor

Package	Description
com.atlassian.plugin
com.atlassian.plugin.event.events	This package contains events that will be fired by the framework.
com.atlassian.plugin.factories
com.atlassian.plugin.metadata
com.atlassian.plugin.module
com.atlassian.plugin.predicate

Uses of ModuleDescriptor in com.atlassian.plugin

Methods in com.atlassian.plugin with type parameters of type ModuleDescriptor

Modifier and Type	Method and Description
default <D extends ModuleDescriptor<?>> List<D>	PluginAccessor.getActiveModuleDescriptorsByClass(Class<D> descriptorClazz) Deprecated. in 5.0 for removal in 6.0 when ScopeManager is removed. Use PluginAccessor.getEnabledModuleDescriptorsByClass(Class) instead.
<D extends ModuleDescriptor<?>> List<D>	PluginAccessor.getEnabledModuleDescriptorsByClass(Class<D> descriptorClazz) Get all enabled module descriptors that have a specific descriptor class.

Methods in com.atlassian.plugin that return ModuleDescriptor

Modifier and Type	Method and Description
ModuleDescriptor<?>	PluginController.addDynamicModule(Plugin plugin, org.dom4j.Element module) Add a new module described by element to the plugin specified.
ModuleDescriptor<?>	PluginAccessor.getEnabledPluginModule(String completeKey) Retrieve an enabled plugin module by complete module key.
ModuleDescriptor<?>	ModuleDescriptorFactory.getModuleDescriptor(String type)
ModuleDescriptor<?>	Plugin.getModuleDescriptor(String key) Get the ModuleDescriptor for a particular key.
ModuleDescriptor<?>	DummyPlugin.getModuleDescriptor(String key)
ModuleDescriptor<?>	PluginAccessor.getPluginModule(String completeKey) Retrieve any plugin module by complete module key.

Methods in com.atlassian.plugin that return types with arguments of type ModuleDescriptor

Modifier and Type	Method and Description
Iterable<ModuleDescriptor<?>>	PluginAccessor.getDynamicModules(Plugin plugin) Retrieve all currently registered dynamic modules i.e.
Class<? extends ModuleDescriptor>	ModuleDescriptorFactory.getModuleDescriptorClass(String type)
Collection<ModuleDescriptor<?>>	Plugin.getModuleDescriptors() Get the Collection of descriptors.
Collection<ModuleDescriptor<?>>	DummyPlugin.getModuleDescriptors()
default <M> Collection<ModuleDescriptor<M>>	PluginAccessor.getModuleDescriptors(ModuleDescriptorPredicate<M> moduleDescriptorPredicate) Deprecated. in 5.0 for removal in 6.0. Use PluginAccessor.getModuleDescriptors(Predicate) instead.
<M> Collection<ModuleDescriptor<M>>	PluginAccessor.getModuleDescriptors(Predicate<ModuleDescriptor<M>> moduleDescriptorPredicate) Gets all module descriptors of installed modules that match the given predicate.
<M> List<ModuleDescriptor<M>>	Plugin.getModuleDescriptorsByModuleClass(Class<M> moduleClass) Get the descriptors whose module class implements or is assignable from the supplied Class.
<M> List<ModuleDescriptor<M>>	DummyPlugin.getModuleDescriptorsByModuleClass(Class<M> moduleClass)

Methods in com.atlassian.plugin with parameters of type ModuleDescriptor

Modifier and Type	Method and Description
void	Plugin.addModuleDescriptor(ModuleDescriptor<?> moduleDescriptor)
void	DummyPlugin.addModuleDescriptor(ModuleDescriptor<?> moduleDescriptor)
boolean	StoredPluginState.isEnabled(ModuleDescriptor<?> pluginModule) Whether or not a given plugin module is enabled, calculated from its persisted state AND default state.
void	PluginController.removeDynamicModule(Plugin plugin, ModuleDescriptor<?> module) Remove a module that was dynamically added to plugin..

Method parameters in com.atlassian.plugin with type arguments of type ModuleDescriptor

Modifier and Type	Method and Description
<M> Collection<ModuleDescriptor<M>>	PluginAccessor.getModuleDescriptors(Predicate<ModuleDescriptor<M>> moduleDescriptorPredicate) Gets all module descriptors of installed modules that match the given predicate.
<M> Collection<M>	PluginAccessor.getModules(Predicate<ModuleDescriptor<M>> moduleDescriptorPredicate) Gets all installed modules that match the given predicate.

Uses of ModuleDescriptor in com.atlassian.plugin.event.events

Methods in com.atlassian.plugin.event.events that return ModuleDescriptor

Modifier and Type	Method and Description
ModuleDescriptor<?>	PluginModuleEvent.getModule()

Method parameters in com.atlassian.plugin.event.events with type arguments of type ModuleDescriptor

Modifier and Type

Method and Description

boolean

PluginTransactionEndEvent.hasAnyEventWithModuleDescriptorMatching(Predicate<ModuleDescriptor<?>> anyMatchModuleDescriptorPredicate) Returns true if any event of type PluginModuleEvent with PluginModuleEvent.getModule() matching anyMatchModuleDescriptorPredicate was part of this transaction, or if any event of type PluginEvent with PluginEvent.getPlugin() with any Plugin.getModuleDescriptors() matching anyMatchModuleDescriptorPredicate was part of this transaction.

Constructors in com.atlassian.plugin.event.events with parameters of type ModuleDescriptor

Constructor and Description
PluginModuleAvailableEvent(ModuleDescriptor module)
PluginModuleDisabledEvent(ModuleDescriptor<?> module, boolean persistent)
PluginModuleDisablingEvent(ModuleDescriptor<?> module, boolean persistent)
PluginModuleEnabledEvent(ModuleDescriptor<?> module)
PluginModuleEnablingEvent(ModuleDescriptor<?> module)
PluginModuleEvent(ModuleDescriptor<?> module)
PluginModulePersistentEvent(ModuleDescriptor<?> module, boolean persistent)
PluginModuleUnavailableEvent(ModuleDescriptor<?> module)

Uses of ModuleDescriptor in com.atlassian.plugin.factories

Methods in com.atlassian.plugin.factories that return ModuleDescriptor

Modifier and Type	Method and Description
ModuleDescriptor<?>	PluginFactory.createModule(Plugin plugin, org.dom4j.Element module, ModuleDescriptorFactory moduleDescriptorFactory) If this factory is capable of loading a plugin of the type passed, attempt to create a module descriptor.

Uses of ModuleDescriptor in com.atlassian.plugin.metadata

Methods in com.atlassian.plugin.metadata with parameters of type ModuleDescriptor

Modifier and Type	Method and Description
boolean	PluginMetadataManager.isOptional(ModuleDescriptor<?> moduleDescriptor) This is used to determine if a module is considered optional.

Uses of ModuleDescriptor in com.atlassian.plugin.module

Methods in com.atlassian.plugin.module with parameters of type ModuleDescriptor

Modifier and Type	Method and Description
<T> T	LegacyModuleFactory.createModule(String name, ModuleDescriptor<T> moduleDescriptor)
<T> T	ModuleFactory.createModule(String name, ModuleDescriptor<T> moduleDescriptor) Creates the module instance.
<T> Class<T>	LegacyModuleFactory.getModuleClass(String name, ModuleDescriptor<T> moduleDescriptor)

Uses of ModuleDescriptor in com.atlassian.plugin.predicate

Methods in com.atlassian.plugin.predicate with parameters of type ModuleDescriptor

Modifier and Type	Method and Description
boolean	ModuleDescriptorPredicate.matches(ModuleDescriptor<? extends T> moduleDescriptor) Deprecated. Will match a plugin module according to implementation rules.