public class

UnloadableModuleDescriptor

extends AbstractModuleDescriptor<T>
java.lang.Object
   ↳ com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
     ↳ com.atlassian.plugin.descriptors.UnloadableModuleDescriptor

Class Overview

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

Summary

[Expand]
Inherited Fields
From class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
Public Constructors
UnloadableModuleDescriptor()
Public Methods
String getErrorText()
Void getModule()
The particular module object created by this plugin.
boolean isEnabledByDefault()
Whether or not this plugin module is enabled by default.
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.
Protected Methods
void loadClass(Plugin plugin, Element element)
This method is deprecated. Since 2.1.0, use loadClass(Plugin, String) instead
[Expand]
Inherited Methods
From class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
From class java.lang.Object
From interface com.atlassian.plugin.ModuleDescriptor
From interface com.atlassian.plugin.Resourced
From interface com.atlassian.plugin.StateAware

Public Constructors

public UnloadableModuleDescriptor ()

Public Methods

public String getErrorText ()

public Void getModule ()

The particular module object created by this plugin.

Returns
  • The module object created by this plugin.

public boolean isEnabledByDefault ()

Whether or not this plugin module is enabled by default.

Returns
  • true if this plugin module is enabled by default.

public void setErrorText (String errorText)

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

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

Protected Methods

protected void loadClass (Plugin plugin, Element element)

This method is deprecated.
Since 2.1.0, use loadClass(Plugin, String) instead

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

Throws
PluginParseException