com.atlassian.plugin.descriptors
Class UnloadableModuleDescriptor

java.lang.Object
  com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Void>
      com.atlassian.plugin.descriptors.UnloadableModuleDescriptor

All Implemented Interfaces:

ModuleDescriptor<Void>, Resourced, StateAware

public class UnloadableModuleDescriptor
extends AbstractModuleDescriptor<Void>

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

moduleClass, moduleClassName, moduleFactory, plugin, resources, singleton

Constructor Summary

UnloadableModuleDescriptor()

Method Summary

String	getErrorText()
Void	getModule() The particular module object created by this plugin.
boolean	isEnabledByDefault() Whether or not this plugin module is enabled by default.
protected void	loadClass(Plugin plugin, org.dom4j.Element element) Override this for module descriptors which don't expect to be able to load a class successfully
void	setErrorText(String errorText)
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 UnloadableModuleDescriptor when we don't have the XML Element.
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 UnloadableModuleDescriptor when we don't have the XML Element.

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

assertModuleClassImplements, destroy, disabled, enabled, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getName, getParams, getPlugin, getPluginKey, getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation, hashCode, init, isSingleton, isSingletonByDefault, isSystemModule, loadClass, provideValidationRules, satisfiesMinJavaVersion, setPlugin, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

UnloadableModuleDescriptor

public UnloadableModuleDescriptor()

Method Detail

getModule

public Void getModule()

Description copied from interface: ModuleDescriptor

The particular module object created by this plugin.

Specified by:

getModule in interface ModuleDescriptor<Void>

Specified by:

getModule in class AbstractModuleDescriptor<Void>

Returns:

The module object created by this plugin.

See Also:

ModuleDescriptor.getModuleClass()

loadClass

protected void loadClass(Plugin plugin,
                         org.dom4j.Element element)
                  throws PluginParseException

Description copied from class: AbstractModuleDescriptor

Override this for module descriptors which don't expect to be able to load a class successfully

Overrides:

loadClass in class AbstractModuleDescriptor<Void>

Throws:

PluginParseException

isEnabledByDefault

public boolean isEnabledByDefault()

Description copied from interface: ModuleDescriptor

Whether or not this plugin module is enabled by default.

Specified by:

isEnabledByDefault in interface ModuleDescriptor<Void>

Overrides:

isEnabledByDefault in class AbstractModuleDescriptor<Void>

Returns:

true if this plugin module is enabled by default.

getErrorText

public String getErrorText()

setErrorText

public void setErrorText(String errorText)

setKey

public 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 UnloadableModuleDescriptor when we don't have the XML Element.

Parameters:

key - the key of the ModuleDescriptor

setName

public 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 UnloadableModuleDescriptor when we don't have the XML Element.

Parameters:

name - the name of the ModuleDescriptor