Package com.atlassian.plugin.module

Class PrefixDelegatingModuleFactory

java.lang.Object

com.atlassian.plugin.module.PrefixDelegatingModuleFactory

All Implemented Interfaces:

ModuleFactory

public class PrefixDelegatingModuleFactory
extends Object
implements ModuleFactory

The default implementation of a ModuleFactory. The module class name can contain a prefix and this prefix determines which ModuleFactory is used to create the java class for this module descriptor.

If no prefix is supplied it will use ClassPrefixModuleFactory to create the module class object.

ModuleFactories are located via the following algorithm. First, the prefixes registered during construction are searched, then any implementations in the plugin's container, if applicable.

Implementation note: The plugin's container is searched, instead of a general search for all OSGi services registered against PrefixModuleFactory, because the factories have to be available before any modules are created, and Spring DM, for example, ensures all required service references are available before creating the context, which is then interpreted as an enabled plugin.

Since:

2.5.0

Field Summary

Fields inherited from interface com.atlassian.plugin.module.ModuleFactory

LEGACY_MODULE_FACTORY

Constructor Summary

Constructors

Constructor	Description
PrefixDelegatingModuleFactory(Set<PrefixModuleFactory> delegates)

Method Summary

Modifier and Type	Method	Description
void	addPrefixModuleFactory(PrefixModuleFactory prefixModuleFactory)
<T> T	createModule(String className, ModuleDescriptor<T> moduleDescriptor)
protected ModuleFactory	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> Class<T>	guessModuleClass(String name, ModuleDescriptor<T> moduleDescriptor)	Deprecated. Since 2.5.0

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PrefixDelegatingModuleFactory

public PrefixDelegatingModuleFactory(Set<PrefixModuleFactory> delegates)

Method Details

addPrefixModuleFactory

public void addPrefixModuleFactory(PrefixModuleFactory prefixModuleFactory)

getModuleFactoryForPrefix

protected ModuleFactory 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.

Parameters:

moduleReference - The module reference

moduleDescriptor - The descriptor containing the module

Returns:

The instance, can return null

createModule

public <T> T createModule(String className,
 ModuleDescriptor<T> moduleDescriptor)

Specified by:

createModule in interface ModuleFactory

guessModuleClass

@Deprecated
public <T> Class<T> guessModuleClass(String name,
 ModuleDescriptor<T> moduleDescriptor)

Deprecated.

Since 2.5.0

This is not to be used. It is only for backwards compatibility with old code that uses PluginAccessor.getEnabledModulesByClass(Class). This method can and will be removed without warning.

Type Parameters:

T - The module class type

Parameters:

name - The class name

moduleDescriptor - The module descriptor

Returns:

The module class

Throws:

ModuleClassNotFoundException