Class InstalledExtension
- java.lang.Object
-
- ca.cgjennings.apps.arkham.plugins.InstalledBundleObject
-
- ca.cgjennings.apps.arkham.plugins.AbstractInstalledPlugin
-
- ca.cgjennings.apps.arkham.plugins.InstalledExtension
-
- All Implemented Interfaces:
IconProvider
,java.lang.Comparable<InstalledBundleObject>
public final class InstalledExtension extends AbstractInstalledPlugin
AnInstalledExtension
bridges the gap between an extension plug-in bundle and the plug-ins that it contains. It is not the plug-in itself, but it creates and manages instances of the plug-in on demand. When a plug-in bundle is installed, an instance is created for each plug-in listed in the bundle's root file.- Since:
- 3.0
- Author:
- Chris Jennings
- See Also:
BundleInstaller.getInstalledExtensions()
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
collectPluginInfo(Plugin p)
Called to allow subclasses to collect additional information about a plug-in while an information probe is being conducted.protected boolean
isReloadable()
Returnstrue
if this plug-in is a reloadable type, or false if it is only run once (and thus should be run at the same time as the plug-in info is collected).Plugin
startPlugin()
Instantiates and initializes the plug-in represented by this InstalledPlugin.-
Methods inherited from class ca.cgjennings.apps.arkham.plugins.AbstractInstalledPlugin
equals, getDescription, getIcon, getName, getPlugin, getPluginClass, getPluginType, getSettingPrefix, getVersion, hashCode, isStarted, stopPlugin
-
Methods inherited from class ca.cgjennings.apps.arkham.plugins.InstalledBundleObject
compareTo, getBundle, getCatalogID, getPluginRoot, getPriority, getRepresentativeImage, isUninstallPending, isUpdatePending, markFailed, toString
-
-
-
-
Method Detail
-
startPlugin
public Plugin startPlugin() throws PluginException
Instantiates and initializes the plug-in represented by this InstalledPlugin. If an instance already exists, that instance is returned as if byAbstractInstalledPlugin.getPlugin()
.- Overrides:
startPlugin
in classAbstractInstalledPlugin
- Returns:
- the started plug-in instance
- Throws:
java.lang.IllegalStateException
- if the extension was started previouslyPluginException
- if the plug-in cannot be started
-
collectPluginInfo
protected void collectPluginInfo(Plugin p)
Description copied from class:AbstractInstalledPlugin
Called to allow subclasses to collect additional information about a plug-in while an information probe is being conducted. The base class does nothing.- Overrides:
collectPluginInfo
in classAbstractInstalledPlugin
-
isReloadable
protected boolean isReloadable()
Description copied from class:AbstractInstalledPlugin
Returnstrue
if this plug-in is a reloadable type, or false if it is only run once (and thus should be run at the same time as the plug-in info is collected).- Overrides:
isReloadable
in classAbstractInstalledPlugin
- Returns:
false
if the plug-in is an extension,true
otherwise
-
-