Uses of Interface
com.atlassian.plugin.ModuleDescriptor

Packages that use ModuleDescriptor

Package	Description
com.atlassian.plugin
com.atlassian.plugin.descriptors
com.atlassian.plugin.event.events	This package contains events that will be fired by the framework.
com.atlassian.plugin.impl
com.atlassian.plugin.manager
com.atlassian.plugin.metadata
com.atlassian.plugin.module
com.atlassian.plugin.parsers
com.atlassian.plugin.predicate
com.atlassian.plugin.tracker

Uses of ModuleDescriptor in com.atlassian.plugin

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

Modifier and Type	Method and Description
<D extends ModuleDescriptor<?>> java.util.List<D>	PluginAccessor.getEnabledModuleDescriptorsByClass(java.lang.Class<D> descriptorClazz) Get all enabled module descriptors that have a specific descriptor class.
<D extends ModuleDescriptor<?>> java.util.List<D>	PluginAccessor.getEnabledModuleDescriptorsByClass(java.lang.Class<D> descriptorClazz, boolean verbose) Deprecated. Since 2.3.0, use #getEnabledModuleDescriptorsByClass(Class) instead

Methods in com.atlassian.plugin that return ModuleDescriptor

Modifier and Type	Method and Description
ModuleDescriptor<?>	PluginAccessor.getEnabledPluginModule(java.lang.String completeKey) Retrieve an enabled plugin module by complete module key.
ModuleDescriptor<?>	Plugin.getModuleDescriptor(java.lang.String key) Get the ModuleDescriptor for a particular key.
ModuleDescriptor<?>	DefaultModuleDescriptorFactory.getModuleDescriptor(java.lang.String type)
ModuleDescriptor<?>	ModuleDescriptorFactory.getModuleDescriptor(java.lang.String type)
ModuleDescriptor<?>	PluginAccessor.getPluginModule(java.lang.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
protected java.util.Map<java.lang.String,java.lang.Class<? extends ModuleDescriptor>>	DefaultModuleDescriptorFactory.getDescriptorClassesMap()
<M> java.util.List<ModuleDescriptor<M>>	PluginAccessor.getEnabledModuleDescriptorsByType(java.lang.String type) Deprecated. since 0.17, use PluginAccessor.getModuleDescriptors(com.atlassian.plugin.predicate.ModuleDescriptorPredicate) with an appropriate predicate instead.
java.lang.Class<? extends ModuleDescriptor>	DefaultModuleDescriptorFactory.getModuleDescriptorClass(java.lang.String type)
java.lang.Class<? extends ModuleDescriptor>	ModuleDescriptorFactory.getModuleDescriptorClass(java.lang.String type)
java.util.Collection<ModuleDescriptor<?>>	Plugin.getModuleDescriptors() Get the Collection of descriptors.
<M> java.util.Collection<ModuleDescriptor<M>>	PluginAccessor.getModuleDescriptors(ModuleDescriptorPredicate<M> moduleDescriptorPredicate) Gets all module descriptors of installed modules that match the given predicate.
<M> java.util.List<ModuleDescriptor<M>>	Plugin.getModuleDescriptorsByModuleClass(java.lang.Class<M> moduleClass) Get the descriptors whose module class implements or is assignable from the supplied Class.

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

Modifier and Type	Method and Description
void	Plugin.addModuleDescriptor(ModuleDescriptor<?> moduleDescriptor)

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

Modifier and Type	Method and Description
void	DefaultModuleDescriptorFactory.addModuleDescriptor(java.lang.String type, java.lang.Class<? extends ModuleDescriptor> moduleDescriptorClass)
<M> java.util.List<M>	PluginAccessor.getEnabledModulesByClassAndDescriptor(java.lang.Class<ModuleDescriptor<M>> descriptorClass, java.lang.Class<M> moduleClass) Deprecated. since 0.17, use PluginAccessor.getModules(com.atlassian.plugin.predicate.ModuleDescriptorPredicate) with an appropriate predicate instead.

Uses of ModuleDescriptor in com.atlassian.plugin.descriptors

Classes in com.atlassian.plugin.descriptors that implement ModuleDescriptor

Modifier and Type	Class and Description
class	AbstractModuleDescriptor<T>
class	ResourcedModuleDescriptor<T> Deprecated. All module descriptors now have resources. Use AbstractModuleDescriptor instead.
class	UnloadableModuleDescriptor Instances of this class represent a module which could not be loaded, not a module which can be unloaded.
class	UnrecognisedModuleDescriptor
class	UnrecognisedModuleDescriptorRequiringRestart

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

Modifier and Type	Method and Description
ModuleDescriptor<?>	ChainModuleDescriptorFactory.getModuleDescriptor(java.lang.String type)

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

Modifier and Type	Method and Description
java.lang.Class<? extends ModuleDescriptor>	ChainModuleDescriptorFactory.getModuleDescriptorClass(java.lang.String type)

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

Modifier and Type	Method and Description
static UnloadableModuleDescriptor	UnloadableModuleDescriptorFactory.createUnloadableModuleDescriptor(Plugin plugin, ModuleDescriptor<?> descriptor, java.lang.Throwable e) Creates a new UnloadableModuleDescriptor based on an existing ModuleDescriptor, descriptor This method uses the information in an existing descriptor to construct a new UnloadableModuleDescriptor.
ModuleDescriptors.EqualsBuilder	ModuleDescriptors.EqualsBuilder.descriptor(ModuleDescriptor descriptor) Sets the module descriptor to create an equals implementation for.
ModuleDescriptors.HashCodeBuilder	ModuleDescriptors.HashCodeBuilder.descriptor(ModuleDescriptor descriptor) Sets the module descriptor to create a hashCode implementation for.

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	PluginModuleUnavailableEvent.getModule()
ModuleDescriptor	PluginModuleAvailableEvent.getModule()
ModuleDescriptor	PluginModuleDisabledEvent.getModule()
ModuleDescriptor	PluginModuleEnabledEvent.getModule()

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

Constructor and Description
PluginModuleAvailableEvent(ModuleDescriptor module)
PluginModuleDisabledEvent(ModuleDescriptor module, boolean persistent)
PluginModuleEnabledEvent(ModuleDescriptor module)
PluginModuleUnavailableEvent(ModuleDescriptor module)

Uses of ModuleDescriptor in com.atlassian.plugin.impl

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

Modifier and Type	Method and Description
ModuleDescriptor<?>	AbstractDelegatingPlugin.getModuleDescriptor(java.lang.String key)
ModuleDescriptor<?>	AbstractPlugin.getModuleDescriptor(java.lang.String key)

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

Modifier and Type	Method and Description
java.util.Collection<ModuleDescriptor<?>>	AbstractDelegatingPlugin.getModuleDescriptors()
java.util.Collection<ModuleDescriptor<?>>	AbstractPlugin.getModuleDescriptors() Returns the module descriptors for this plugin
<M> java.util.List<ModuleDescriptor<M>>	AbstractDelegatingPlugin.getModuleDescriptorsByModuleClass(java.lang.Class<M> moduleClass)
<T> java.util.List<ModuleDescriptor<T>>	AbstractPlugin.getModuleDescriptorsByModuleClass(java.lang.Class<T> aClass)

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

Modifier and Type	Method and Description
void	AbstractDelegatingPlugin.addModuleDescriptor(ModuleDescriptor<?> moduleDescriptor)
void	AbstractPlugin.addModuleDescriptor(ModuleDescriptor<?> moduleDescriptor)

Uses of ModuleDescriptor in com.atlassian.plugin.manager

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

Modifier and Type	Method and Description
<D extends ModuleDescriptor<?>> java.util.List<D>	EnabledModuleCachingPluginAccessor.getEnabledModuleDescriptorsByClass(java.lang.Class<D> descriptorClazz)
<D extends ModuleDescriptor<?>> java.util.List<D>	DefaultPluginManager.getEnabledModuleDescriptorsByClass(java.lang.Class<D> descriptorClazz) This method has been reverted to pre PLUG-40 to fix performance issues that were encountered during load testing.
<D extends ModuleDescriptor<?>> java.util.List<D>	DefaultPluginManager.getEnabledModuleDescriptorsByClass(java.lang.Class<D> descriptorClazz, boolean verbose)

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

Modifier and Type	Method and Description
ModuleDescriptor<?>	DefaultPluginManager.getEnabledPluginModule(java.lang.String completeKey)
ModuleDescriptor<?>	DefaultPluginManager.getPluginModule(java.lang.String completeKey)

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

Modifier and Type	Method and Description
<M> java.util.List<ModuleDescriptor<M>>	DefaultPluginManager.getEnabledModuleDescriptorsByType(java.lang.String type) Deprecated. since 0.17, use DefaultPluginManager.getModuleDescriptors(com.atlassian.plugin.predicate.ModuleDescriptorPredicate) with an appropriate predicate instead.
<M> java.util.Collection<ModuleDescriptor<M>>	DefaultPluginManager.getModuleDescriptors(ModuleDescriptorPredicate<M> moduleDescriptorPredicate)

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

Modifier and Type	Method and Description
protected void	DefaultPluginManager.disablePluginModuleState(ModuleDescriptor<?> module, PluginPersistentStateStore stateStore)
protected void	DefaultPluginManager.enablePluginModuleState(ModuleDescriptor<?> module, PluginPersistentStateStore stateStore)
boolean	PluginPersistentState.isEnabled(ModuleDescriptor<?> pluginModule) Whether or not a given plugin module is enabled in this state, calculated from it's current state AND default state.
boolean	DefaultPluginPersistentState.isEnabled(ModuleDescriptor<?> pluginModule)
protected void	DefaultPluginManager.notifyModuleDisabled(ModuleDescriptor<?> module)
protected void	DefaultPluginManager.notifyModuleEnabled(ModuleDescriptor<?> module)
PluginPersistentState.Builder	PluginPersistentState.Builder.setEnabled(ModuleDescriptor<?> pluginModule, boolean isEnabled)

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

Modifier and Type	Method and Description
<M> java.util.List<M>	DefaultPluginManager.getEnabledModulesByClassAndDescriptor(java.lang.Class<ModuleDescriptor<M>> descriptorClass, java.lang.Class<M> moduleClass) Deprecated. since 0.17, use DefaultPluginManager.getModules(com.atlassian.plugin.predicate.ModuleDescriptorPredicate) with an appropriate predicate instead.

Constructor parameters in com.atlassian.plugin.manager with type arguments of type ModuleDescriptor

Constructor and Description
EnabledModuleCachingPluginAccessor(PluginAccessor delegate, PluginEventManager pluginEventManager, ConcurrentCacheFactory<java.lang.Class<ModuleDescriptor<java.lang.Object>>,PluginModuleTracker<java.lang.Object,ModuleDescriptor<java.lang.Object>>> pluginModuleTrackerCacheFactory)
EnabledModuleCachingPluginAccessor(PluginAccessor delegate, PluginEventManager pluginEventManager, ConcurrentCacheFactory<java.lang.Class<ModuleDescriptor<java.lang.Object>>,PluginModuleTracker<java.lang.Object,ModuleDescriptor<java.lang.Object>>> pluginModuleTrackerCacheFactory)

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	DefaultPluginMetadataManager.isOptional(ModuleDescriptor<?> moduleDescriptor) A module is determined to be optional if the host application has not indicated to the plugins system that it is required.
boolean	PluginMetadataManager.isOptional(ModuleDescriptor<?> moduleDescriptor) This is used to determine if a module is considered optional.
boolean	ClasspathFilePluginMetadata.required(ModuleDescriptor<?> module)

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	ModuleFactory.createModule(java.lang.String name, ModuleDescriptor<T> moduleDescriptor) Creates the module instance.
<T> T	HostContainerLegacyAdaptor.createModule(java.lang.String name, ModuleDescriptor<T> moduleDescriptor)
<T> T	LegacyModuleFactory.createModule(java.lang.String name, ModuleDescriptor<T> moduleDescriptor)
<T> T	PrefixDelegatingModuleFactory.createModule(java.lang.String className, ModuleDescriptor<T> moduleDescriptor)
<T> T	ClassPrefixModuleFactory.createModule(java.lang.String name, ModuleDescriptor<T> moduleDescriptor)
<T> java.lang.Class<T>	LegacyModuleFactory.getModuleClass(java.lang.String name, ModuleDescriptor<T> moduleDescriptor)
protected ModuleFactory	PrefixDelegatingModuleFactory.getModuleFactoryForPrefix(com.atlassian.plugin.module.PrefixDelegatingModuleFactory.ModuleReference moduleReference, ModuleDescriptor<?> moduleDescriptor) Returns the module factory for a prefix, first using registered prefixes, then any from the plugin's container.
<T> java.lang.Class<T>	PrefixDelegatingModuleFactory.guessModuleClass(java.lang.String name, ModuleDescriptor<T> moduleDescriptor) Deprecated. Since 2.5.0

Uses of ModuleDescriptor in com.atlassian.plugin.parsers

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

Modifier and Type	Method and Description
protected ModuleDescriptor<?>	XmlDescriptorParser.createModuleDescriptor(Plugin plugin, org.dom4j.Element element, ModuleDescriptorFactory moduleDescriptorFactory)

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	ModulePredicate.matches(ModuleDescriptor moduleDescriptor) Deprecated. Will match a plugin module according to implementation rules.
boolean	ModuleDescriptorOfClassPredicate.matches(ModuleDescriptor<? extends T> moduleDescriptor)
boolean	EnabledModulePredicate.matches(ModuleDescriptor<? extends T> moduleDescriptor)
boolean	ModuleDescriptorPredicate.matches(ModuleDescriptor<? extends T> moduleDescriptor) Will match a plugin module according to implementation rules.
boolean	ModuleOfClassPredicate.matches(ModuleDescriptor<? extends T> moduleDescriptor)

Constructor parameters in com.atlassian.plugin.predicate with type arguments of type ModuleDescriptor

Constructor and Description
ModuleDescriptorOfClassPredicate(java.lang.Class<? extends ModuleDescriptor<? extends T>> moduleDescriptorClass)

Uses of ModuleDescriptor in com.atlassian.plugin.tracker

Classes in com.atlassian.plugin.tracker with type parameters of type ModuleDescriptor

Modifier and Type	Class and Description
class	DefaultPluginModuleTracker<M,T extends ModuleDescriptor<M>> Tracks enabled plugin module descriptors, focusing on fast reads
interface	PluginModuleTracker<M,T extends ModuleDescriptor<M>> Tracks enabled plugin module descriptors, focusing on fast reads.
static interface	PluginModuleTracker.Customizer<M,T extends ModuleDescriptor<M>> Implement this to customize how and which descriptors are stored

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

Modifier and Type	Method and Description
static <M,T extends ModuleDescriptor<M>> PluginModuleTracker<M,T>	DefaultPluginModuleTracker.create(PluginAccessor pluginAccessor, PluginEventManager pluginEventManager, java.lang.Class<? extends ModuleDescriptor<?>> moduleDescriptorClass) Static factory method for constructing trackers generically where M is not known.

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

Modifier and Type	Method and Description
static <M,T extends ModuleDescriptor<M>> PluginModuleTracker<M,T>	DefaultPluginModuleTracker.create(PluginAccessor pluginAccessor, PluginEventManager pluginEventManager, java.lang.Class<? extends ModuleDescriptor<?>> moduleDescriptorClass) Static factory method for constructing trackers generically where M is not known.