com.atlassian.plugin.descriptors
Class UnrecognisedModuleDescriptor

java.lang.Object
  extended by com.atlassian.plugin.descriptors.AbstractModuleDescriptor
      extended by com.atlassian.plugin.descriptors.UnrecognisedModuleDescriptor
All Implemented Interfaces:
ModuleDescriptor, Resourced, StateAware

public class UnrecognisedModuleDescriptor
extends AbstractModuleDescriptor


Field Summary
 
Fields inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
plugin, resources, singleton
 
Constructor Summary
UnrecognisedModuleDescriptor()
           
 
Method Summary
 java.lang.String getErrorText()
           
 java.lang.Object getModule()
          The particular module object created by this plugin.
 void init(Plugin plugin, org.dom4j.Element element)
          Initialise a module given it's parent plugin and the XML element representing the module.
 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 UnrecognisedModuleDescriptor 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 UnrecognisedModuleDescriptor when we don't have the XML Element.
 
Methods inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
assertModuleClassImplements, destroy, disabled, enabled, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getName, getParams, getPlugin, getPluginKey, getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation, isSingleton, isSingletonByDefault, isSystemModule, loadClass, loadClass, satisfiesMinJavaVersion, setPlugin, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

UnrecognisedModuleDescriptor

public UnrecognisedModuleDescriptor()
Method Detail

getModule

public java.lang.Object getModule()
Description copied from interface: ModuleDescriptor
The particular module object created by this plugin.

Specified by:
getModule in interface ModuleDescriptor
Specified by:
getModule in class AbstractModuleDescriptor

init

public void init(Plugin plugin,
                 org.dom4j.Element element)
          throws PluginParseException
Description copied from interface: ModuleDescriptor
Initialise a module given it's parent plugin and the XML element representing the module.

Specified by:
init in interface ModuleDescriptor
Overrides:
init in class AbstractModuleDescriptor
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
Overrides:
isEnabledByDefault in class AbstractModuleDescriptor
Returns:

getErrorText

public java.lang.String getErrorText()

setErrorText

public void setErrorText(java.lang.String errorText)

setKey

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

Parameters:
key - the key of the ModuleDescriptor

setName

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

Parameters:
name - the name of the ModuleDescriptor


Copyright © 2008 Atlassian Pty Ltd. All Rights Reserved.