Package com.atlassian.plugin.module

Interface ModuleFactory

All Known Implementing Classes:
LegacyModuleFactory
public interface ModuleFactory
The ModuleFactory creates the module class of a ModuleDescriptor. The ModuleFactory is injected into the AbstractModuleDescriptor and encapsulates the different strategies how the module class can be created.
Since:
2.5.0

  • Field Details

    • LEGACY_MODULE_FACTORY

      static final ModuleFactory LEGACY_MODULE_FACTORY

  • Method Details

    • createModule

      <T> T createModule(String name, ModuleDescriptor<T> moduleDescriptor)
      Creates the module instance. The module class name can contain a prefix. The delimiter of the prefix and the class name is ':'. E.g.: 'bean:httpServletBean'. Which prefixes are supported depends on the registered ModuleCreator. The prefix is case in-sensitive.
      Parameters:
      name - module class name, can contain a prefix followed by ":" and the class name. Cannot be null. If no prefix provided a default behaviour is assumed how to create the module class.
      moduleDescriptor - the ModuleDescriptor. Cannot be null
      Returns:
      an instantiated object of the module class.
      Throws:
      PluginParseException - If it failed to create the object.