com.atlassian.plugin.impl

Class UnloadablePlugin

java.lang.Object

com.atlassian.plugin.impl.AbstractPlugin

com.atlassian.plugin.impl.StaticPlugin

com.atlassian.plugin.impl.UnloadablePlugin

All Implemented Interfaces:

Plugin, Resourced, Comparable<Plugin>

public class UnloadablePlugin
extends StaticPlugin

This class represents a Plugin that was not able to be loaded by the PluginManager.

See Also:

DefaultPluginManager

Field Summary

Fields inherited from interface com.atlassian.plugin.Plugin

NAME_COMPARATOR, VERSION_1, VERSION_2, VERSION_3

Constructor Summary

Constructors

Constructor and Description
UnloadablePlugin()
UnloadablePlugin(String text)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Free any resources held by this plugin.
String	getErrorText()
boolean	isDeleteable() Should the plugin file be deleted on unistall?
boolean	isDynamicallyLoaded() Whether or not this plugin is loaded dynamically at runtime.
boolean	isEnabledByDefault()
boolean	isUninstallable() Static plugins loaded from the classpath can't be uninstalled.
void	setDeletable(boolean deletable)
void	setDynamicallyLoaded(boolean dynamic)
void	setErrorText(String errorText)
void	setUninstallable(boolean uninstallable)
String	toString()
protected void	uninstallInternal() Perform any internal uninstallation logic.

Methods inherited from class com.atlassian.plugin.impl.StaticPlugin

getClassLoader, getResource, getResourceAsStream, loadClass

Methods inherited from class com.atlassian.plugin.impl.AbstractPlugin

addModuleDescriptor, compareAndSetPluginState, compareTo, containsSystemModule, disable, disableInternal, enable, enableInternal, getActivePermissions, getDateInstalled, getDateLoaded, getI18nNameKey, getInstallationMode, getKey, getLog, getModuleDescriptor, getModuleDescriptors, getModuleDescriptorsByModuleClass, getName, getPluginInformation, getPluginState, getPluginsVersion, getRequiredPlugins, getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation, hasAllPermissions, install, installInternal, isBundledPlugin, isEnabled, isSystemPlugin, removeModuleDescriptor, setEnabled, setEnabledByDefault, setI18nNameKey, setKey, setName, setPluginInformation, setPluginState, setPluginsVersion, setResources, setSystemPlugin, uninstall

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

UnloadablePlugin

public UnloadablePlugin()

UnloadablePlugin

public UnloadablePlugin(String text)

Parameters:

text - The error text

Since:

2.0.0

Method Detail

isUninstallable

public boolean isUninstallable()

Description copied from class: StaticPlugin

Static plugins loaded from the classpath can't be uninstalled.

Specified by:

isUninstallable in interface Plugin

Overrides:

isUninstallable in class StaticPlugin

Returns:

true if this plugin can be 'uninstalled'.

setDeletable

public void setDeletable(boolean deletable)

isDeleteable

public boolean isDeleteable()

Description copied from interface: Plugin

Should the plugin file be deleted on unistall?

Specified by:

isDeleteable in interface Plugin

Overrides:

isDeleteable in class StaticPlugin

Returns:

true if this plugin file should be deleted on unistall.

setUninstallable

public void setUninstallable(boolean uninstallable)

isEnabledByDefault

public boolean isEnabledByDefault()

Specified by:

isEnabledByDefault in interface Plugin

Overrides:

isEnabledByDefault in class AbstractPlugin

getErrorText

public String getErrorText()

setErrorText

public void setErrorText(String errorText)

isDynamicallyLoaded

public boolean isDynamicallyLoaded()

Description copied from interface: Plugin

Whether or not this plugin is loaded dynamically at runtime.

Specified by:

isDynamicallyLoaded in interface Plugin

Overrides:

isDynamicallyLoaded in class StaticPlugin

Returns:

true if this plugin is loaded dynamically at runtime.

setDynamicallyLoaded

public void setDynamicallyLoaded(boolean dynamic)

close

public void close()

Description copied from interface: Plugin

Free any resources held by this plugin. To be called during uninstallation of the Plugin.

Specified by:

close in interface Plugin

Overrides:

close in class AbstractPlugin

uninstallInternal

protected void uninstallInternal()

Description copied from class: AbstractPlugin

Perform any internal uninstallation logic. Subclasses should only throw PluginException.

Overrides:

uninstallInternal in class StaticPlugin

toString

public String toString()

Overrides:

toString in class AbstractPlugin