com.atlassian.plugin.descriptors

Class UnrecognisedModuleDescriptor

java.lang.Object

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

com.atlassian.plugin.descriptors.UnrecognisedModuleDescriptor

All Implemented Interfaces:

ModuleDescriptor<java.lang.Void>, Resourced, StateAware

Direct Known Subclasses:

UnrecognisedModuleDescriptorRequiringRestart

public class UnrecognisedModuleDescriptor
extends AbstractModuleDescriptor<T>

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
UnrecognisedModuleDescriptor()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getErrorText()
T	getModule() The particular module object created by this plugin.
boolean	isEnabledByDefault() Whether or not this plugin module is enabled by default.
void	setErrorText(java.lang.String errorText)
void	setKey(java.lang.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.
void	setName(java.lang.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, destroy, disabled, enabled, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getModuleClassName, getName, getParams, getPlugin, getPluginKey, getRequiredPermissions, getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation, hashCode, init, isSingleton, isSingletonByDefault, isSystemModule, loadClass, loadClass, provideValidationRules, satisfiesMinJavaVersion, setPlugin, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

UnrecognisedModuleDescriptor

public UnrecognisedModuleDescriptor()

Method Detail

getErrorText

public final java.lang.String getErrorText()

setErrorText

public final void setErrorText(java.lang.String errorText)

getModule

public final T getModule()

Description copied from interface: ModuleDescriptor

The particular module object created by this plugin.

Specified by:

getModule in interface ModuleDescriptor<T>

Specified by:

getModule in class AbstractModuleDescriptor<T>

Returns:

The module object created by this plugin.

See Also:

ModuleDescriptor.getModuleClass()

isEnabledByDefault

public final boolean isEnabledByDefault()

Description copied from interface: ModuleDescriptor

Whether or not this plugin module is enabled by default.

Specified by:

isEnabledByDefault in interface ModuleDescriptor<T>

Overrides:

isEnabledByDefault in class AbstractModuleDescriptor<T>

Returns:

true if this plugin module is enabled by default.

setKey

public final void setKey(java.lang.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(java.lang.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