org.xnap.plugin
Class PluginInfo

java.lang.Object
  org.xnap.pkg.PackageInfo
      org.xnap.plugin.PluginInfo

All Implemented Interfaces:

java.lang.Comparable

public class PluginInfo
extends PackageInfo

This class serves as a plugin information record.

Field Summary

Fields inherited from class org.xnap.pkg.PackageInfo

ACTION_INSTALL, DELIMETER, PACKAGE_STATUS_INSTALLED, STATUS_INSTALLED, STATUS_NOT_INSTALLED

Constructor Summary

PluginInfo(java.util.Properties props)

Method Summary

boolean	areRequirementsSatisfied()
boolean	canDisable() Returns true, if the plugin can be disabled.
java.lang.String	getAuthors() Returns the name of the authors of the plugin.
java.lang.String	getClassName() Returns the class name of the class that implements the Plugin interface.
java.lang.String	getDescription() Returns a short description of the plugin's functionality.
boolean	getEnableOnStartup()
java.lang.String	getLicense() Returns the license plugin is published in.
java.lang.String	getLicenseFilename()
Plugin	getPlugin() Returns a reference to the plugin.
java.lang.String	getSection()
boolean	isEnabled() Returns true, if plugin has been loaded and enabled.
boolean	isLoaded() Returns true, if plugin has been loaded.
void	setDisableable(boolean canDisable)
void	setEnabled(boolean newValue) Called by the PluginManager after the plugin has been successfully enabled.
void	setEnableOnStartup(boolean newValue) Called by the xnap.gui.wizard.PluginWizardPanel.
void	setPlugin(Plugin newValue) Sets the reference to the instanciated plugin for this info record to newValue.

Methods inherited from class org.xnap.pkg.PackageInfo

compareTo, compareToVersion, compareToVersion, containsProperties, equals, getAction, getActionStatus, getClassPath, getControlPath, getDepends, getDownloadFilename, getDownloadURLs, getFile, getFilename, getLongDescription, getName, getPackage, getPackageStatus, getProperties, getProperty, getProperty, getPropertyList, getProvides, getReleaseNr, getSize, getStatus, getStatus, getVersion, isAvailable, isBase, isCore, isInstalled, isNew, isPatch, isPlugin, isUpdateAvailable, isValid, putAll, setAction, setAvailable, setClassPath, setControlPath, setDescription, setDownloadFilename, setInstalled, setNew, setPackage, setSection, setStatus, setStatus, setVersion, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginInfo

public PluginInfo(java.util.Properties props)

Method Detail

areRequirementsSatisfied

public boolean areRequirementsSatisfied()

canDisable

public boolean canDisable()

Returns true, if the plugin can be disabled.

getAuthors

public java.lang.String getAuthors()

Returns the name of the authors of the plugin.

Overrides:

getAuthors in class PackageInfo

getClassName

public java.lang.String getClassName()

Returns the class name of the class that implements the Plugin interface.

getDescription

public java.lang.String getDescription()

Returns a short description of the plugin's functionality.

Overrides:

getDescription in class PackageInfo

getEnableOnStartup

public boolean getEnableOnStartup()

getLicense

public java.lang.String getLicense()

Returns the license plugin is published in.

getLicenseFilename

public java.lang.String getLicenseFilename()

getPlugin

public Plugin getPlugin()

Returns a reference to the plugin.

Returns:

null, if plugin is not enabled

getSection

public java.lang.String getSection()

Overrides:

getSection in class PackageInfo

isEnabled

public boolean isEnabled()

Returns true, if plugin has been loaded and enabled.

isLoaded

public boolean isLoaded()

Returns true, if plugin has been loaded.

setDisableable

public void setDisableable(boolean canDisable)

setEnabled

public void setEnabled(boolean newValue)

Called by the PluginManager after the plugin has been successfully enabled.

setEnableOnStartup

public void setEnableOnStartup(boolean newValue)

Called by the xnap.gui.wizard.PluginWizardPanel.

setPlugin

public void setPlugin(Plugin newValue)

Sets the reference to the instanciated plugin for this info record to newValue.