Class PluginModuleHolder<T>
java.lang.Object
com.atlassian.confluence.plugin.module.PluginModuleHolder<T>
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.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
disabled()
void
Changes the state of the module toenabled
.static <T> PluginModuleHolder<T>
getInstance
(PluginModuleFactory<? extends T> pluginModuleFactory) Creates a PluginModuleHolder with a custom module factory.static <T> PluginModuleHolder<T>
getInstanceWithDefaultFactory
(com.atlassian.plugin.ModuleDescriptor<? extends T> moduleDescriptor) Creates a PluginModuleHolder for the given module descriptor with the default factory.Returns the held module.boolean
toString()
-
Method Details
-
getInstanceWithDefaultFactory
public static <T> PluginModuleHolder<T> getInstanceWithDefaultFactory(com.atlassian.plugin.ModuleDescriptor<? extends T> moduleDescriptor) Creates a PluginModuleHolder for the given module descriptor with the default factory.- See Also:
-
getInstance
public static <T> PluginModuleHolder<T> getInstance(PluginModuleFactory<? extends T> pluginModuleFactory) Creates a PluginModuleHolder with a custom module factory. -
enabled
Changes the state of the module toenabled
. If module class isStateAware
the module instance will be created if it does not exist yet and thenenabled()
method on the instance will be called. However if it is notStateAware
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 passedmoduleClass
isStateAware
but the module type is not.
-
disabled
public void disabled() -
isEnabled
public boolean isEnabled() -
getModule
Returns the held module.- Throws:
IllegalStateException
- if the module is not enabled
-
toString
-