Package com.atlassian.plugin.descriptors

Class UnloadableModuleDescriptorFactory

java.lang.Object

com.atlassian.plugin.descriptors.UnloadableModuleDescriptorFactory

public final class UnloadableModuleDescriptorFactory
extends Object

Utility class to create UnloadableModuleDescriptor instances when there are problems

Constructor Summary

Constructors

Constructor	Description
UnloadableModuleDescriptorFactory()

Method Summary

Modifier and Type	Method	Description
static UnloadableModuleDescriptor	createUnloadableModuleDescriptor(Plugin plugin, Element element, Throwable e, ModuleDescriptorFactory moduleDescriptorFactory)	Creates a new UnloadableModuleDescriptor, for when a problem occurs during the construction of the ModuleDescriptor itself.
static UnloadableModuleDescriptor	createUnloadableModuleDescriptor(Plugin plugin, ModuleDescriptor<?> descriptor, Throwable e)	Creates a new UnloadableModuleDescriptor based on an existing ModuleDescriptor, descriptor
static <T extends com.atlassian.plugin.descriptors.AbstractNoOpModuleDescriptor> T	initNoOpModuleDescriptor(T descriptor, Plugin plugin, Element element, Throwable e, ModuleDescriptorFactory moduleDescriptorFactory)

Methods inherited from class java.lang.Object

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

Constructor Details

UnloadableModuleDescriptorFactory

public UnloadableModuleDescriptorFactory()

Method Details

createUnloadableModuleDescriptor

public static UnloadableModuleDescriptor createUnloadableModuleDescriptor(Plugin plugin,
 Element element,
 Throwable e,
 ModuleDescriptorFactory moduleDescriptorFactory)

Creates a new UnloadableModuleDescriptor, for when a problem occurs during the construction of the ModuleDescriptor itself.

This instance has the same information as the original ModuleDescriptor, but also contains an error message that reports the error.

Parameters:

plugin - the Plugin the ModuleDescriptor belongs to

element - the Element used to construct the ModuleDescriptor

e - the Throwable

moduleDescriptorFactory - a ModuleDescriptorFactory used to retrieve ModuleDescriptor instances

Returns:

a new UnloadableModuleDescriptor instance

Throws:

PluginParseException - if there was a problem constructing the UnloadableModuleDescriptor

initNoOpModuleDescriptor

public static <T extends com.atlassian.plugin.descriptors.AbstractNoOpModuleDescriptor>
T initNoOpModuleDescriptor(T descriptor,
 Plugin plugin,
 Element element,
 Throwable e,
 ModuleDescriptorFactory moduleDescriptorFactory)

createUnloadableModuleDescriptor

public static UnloadableModuleDescriptor createUnloadableModuleDescriptor(Plugin plugin,
 ModuleDescriptor<?> descriptor,
 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.

Parameters:

plugin - the Plugin the ModuleDescriptor belongs to

descriptor - the ModuleDescriptor that reported an error

e - the Throwable

Returns:

a new UnloadableModuleDescriptor instance