public class

PluginModuleHolder

extends Object
java.lang.Object
   ↳ com.atlassian.confluence.plugin.module.PluginModuleHolder<T>

Class Overview

Manages the lifecycle of a plugin module of type T that is constructed when the module is first requested via getModule() method. However if module type is StateAware module is created and enabled once enabled() is called.

This class does not have any synchronisation or thread-safety guarantees. It relies on the plugin manager initialising and enabling plugin modules in single-threaded mode to ensure thread safety.

Summary

Public Methods
void disabled()
void enabled(Class<T> moduleClass)
Changes the state of the module to enabled.
static <T> PluginModuleHolder<T> getInstance(PluginModuleFactory<? extends T> pluginModuleFactory)
Creates a PluginModuleHolder with a custom module factory.
static <T> PluginModuleHolder<T> getInstanceWithDefaultFactory(ModuleDescriptor<? extends T> moduleDescriptor)
Creates a PluginModuleHolder for the given module descriptor with the default factory.
T getModule()
Returns the held module.
String toString()
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public void disabled ()

public void enabled (Class<T> moduleClass)

Changes the state of the module to enabled. If module class is StateAware the module instance will be created if it does not exist yet and then enabled() method on the instance will be called. However if it is not StateAware module, its instance will not be created and creation will be deferred until the first time it is used!

Parameters
moduleClass a type of the module that this holder holds. We cannot use the type parameter of this class because of java implementation of generics(erasure).
Throws
ClassCastException if passed moduleClass is StateAware but the module type is not.

public static PluginModuleHolder<T> getInstance (PluginModuleFactory<? extends T> pluginModuleFactory)

Creates a PluginModuleHolder with a custom module factory.

public static PluginModuleHolder<T> getInstanceWithDefaultFactory (ModuleDescriptor<? extends T> moduleDescriptor)

Creates a PluginModuleHolder for the given module descriptor with the default factory.

See Also

public T getModule ()

Returns the held module.

Throws
IllegalStateException if the module is not enabled

public String toString ()