Package com.atlassian.plugin.descriptors

Class UnloadableModuleDescriptor

java.lang.Object

com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>

com.atlassian.plugin.descriptors.UnloadableModuleDescriptor

All Implemented Interfaces:

ModuleDescriptor<Void>, Resourced, ScopeAware, StateAware

public final class UnloadableModuleDescriptor
extends AbstractModuleDescriptor<T>

Instances of this class represent a module which could not be loaded, not a module which can be unloaded.

Field Summary

Fields inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

key, moduleClass, moduleClassName, moduleFactory, name, plugin, resources

Constructor Summary

Constructors

Constructor	Description
UnloadableModuleDescriptor()

Method Summary

Modifier and Type	Method	Description
final String	getErrorText()
final Void	getModule()
final boolean	isEnabledByDefault()
protected void	loadClass(Plugin plugin, String clazz)	Loads the module class that this descriptor provides, and will not necessarily be the implementation class.
final void	setErrorText(String errorText)
final void	setKey(String key)	Sets the key of the ModuleDescriptor This is theoretically bad, as the superclass and the interface doesn't define this method, but it's required to construct an module descriptor when we don't have the XML Element.
final void	setName(String name)	Sets the name of the ModuleDescriptor This is theoretically bad, as the superclass and the interface doesn't define this method, but it's required to construct an module descriptor when we don't have the XML Element.

Methods inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

assertModuleClassImplements, checkPermissions, destroy, disabled, enabled, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getModuleClassName, getName, getParams, getPlugin, getPluginKey, getRequiredPermissions, getResourceDescriptor, getResourceDescriptors, getResourceLocation, getScopeKey, hashCode, init, isBroken, isEnabled, isSystemModule, satisfiesMinJavaVersion, setBroken, setPlugin, toString, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlassian.plugin.ModuleDescriptor

getDisplayName

Constructor Details

UnloadableModuleDescriptor

public UnloadableModuleDescriptor()

Method Details

loadClass

protected void loadClass(Plugin plugin,
 String clazz)

Description copied from class: AbstractModuleDescriptor

Loads the module class that this descriptor provides, and will not necessarily be the implementation class. Override this for module descriptors whose type cannot be determined via generics.

Overrides:

loadClass in class AbstractModuleDescriptor<Void>

clazz - The module class name to load

getErrorText

public final String getErrorText()

setErrorText

public final void setErrorText(String errorText)

getModule

public final Void getModule()

Specified by:

getModule in interface ModuleDescriptor<T>

Specified by:

getModule in class AbstractModuleDescriptor<T>

isEnabledByDefault

public final boolean isEnabledByDefault()

Specified by:

isEnabledByDefault in interface ModuleDescriptor<T>

Overrides:

isEnabledByDefault in class AbstractModuleDescriptor<T>

setKey

public final void setKey(String key)

Sets the key of the ModuleDescriptor This is theoretically bad, as the superclass and the interface doesn't define this method, but it's required to construct an module descriptor when we don't have the XML Element.

Parameters:

key - the key of the ModuleDescriptor

setName

public final void setName(String name)

Sets the name of the ModuleDescriptor This is theoretically bad, as the superclass and the interface doesn't define this method, but it's required to construct an module descriptor when we don't have the XML Element.

Parameters:

name - the name of the ModuleDescriptor