ides.api.plugin
Interface Plugin

public interface Plugin

The main interface of a plugin for IDES.

Refer to the external documentation to learn how to create IDES plugins.

Author:

Lenko Grigorov

Method Summary

java.lang.String	getCredits() Retrieve the authorship of the plugin.
java.lang.String	getDescription() Retrieve a short description of the plugin.
java.lang.String	getLicense() Retrieve the license of the plugin.
java.lang.String	getName() Retrieve the name of the plugin.
java.lang.String	getVersion() Retrieve the version of the plugin.
void	initialize() Called once when the plugin has to be initialized.
void	unload() Called once when the plugin has to be unloaded before IDES shuts down.

Method Detail

initialize

void initialize()
                throws PluginInitException

Called once when the plugin has to be initialized.

Throws:

PluginInitException - can be thrown if the plugin cannot initialize

unload

void unload()

Called once when the plugin has to be unloaded before IDES shuts down.

getName

java.lang.String getName()

Retrieve the name of the plugin.

Returns:

the name of the plugin

getVersion

java.lang.String getVersion()

Retrieve the version of the plugin.

Returns:

the version of the plugin

getCredits

java.lang.String getCredits()

Retrieve the authorship of the plugin.

Returns:

the authorship of the plugin

getLicense

java.lang.String getLicense()

Retrieve the license of the plugin.

Returns:

the license of the plugin

getDescription

java.lang.String getDescription()

Retrieve a short description of the plugin.

Returns:

a short description of the plugin