net.sf.jmp3renamer
Interface Plugin

All Known Subinterfaces:

DataPlugin, FilePlugin, GeneralPlugin

public interface Plugin

The interface Plugin has to be implemented by every PlugIn. There are Subinterfaces which are specializations of this interface.

See Also:

DataPlugin, FilePlugin, GeneralPlugin

Field Summary

static int	DATA Plugin is a DataPlugin.
static int	FILE Plugin is a FilePlugin.
static int	GENERAL Plugin is a GeneralPlugin

Method Summary

void	coreStarted() Called when JMP3Renamer fnished the startup process.
String	getAuthor() Returns the author of this plugin.
Properties	getConfig() Returns the config of this plugin.
PluginConfigGUI	getConfigGUI() Returns a graphical Component for configuring this plugin.
String	getDescription() Returns the description of this plugin.
String	getName() Returns the name of this plugin.
int	getType() Returns the type of this plugin.
String	getVersion() Returns the version of this plugin.
void	init() Called when this plugin is loaded.
void	saveConfig() Saves the config of this plugin to a file.
String	toString() Returns a String representation of this plugin.

Field Detail

DATA

static final int DATA

Plugin is a DataPlugin.

See Also:

Constant Field Values

FILE

static final int FILE

Plugin is a FilePlugin.

See Also:

Constant Field Values

GENERAL

static final int GENERAL

Plugin is a GeneralPlugin

See Also:

Constant Field Values

Method Detail

getType

int getType()

Returns the type of this plugin.

Returns:

The type of this plugin. One out of: Plugin.DATA, Plugin.FILE.

getName

String getName()

Returns the name of this plugin.

Returns:

The name of this plugin, which will be used for menus and so on.

getVersion

String getVersion()

Returns the version of this plugin.

Returns:

The version of this plugin.

getAuthor

String getAuthor()

Returns the author of this plugin.

Returns:

The author of this plugin.

getDescription

String getDescription()

Returns the description of this plugin.

Returns:

The description of this plugin.

getConfig

Properties getConfig()

Returns the config of this plugin.

Returns:

The config of this plugin.

saveConfig

void saveConfig()

Saves the config of this plugin to a file.

getConfigGUI

PluginConfigGUI getConfigGUI()

Returns a graphical Component for configuring this plugin.

Returns:

a graphical Component for configuring this plugin.

init

void init()

Called when this plugin is loaded. Acts like a constructor.

coreStarted

void coreStarted()

Called when JMP3Renamer fnished the startup process.

toString

String toString()

Returns a String representation of this plugin.

Overrides:

toString in class Object

Returns:

a String representation of this plugin.