org.brains2b.coffee.plugin
Interface MimePlugin

All Superinterfaces:

CoffeeExchange

All Known Implementing Classes:

NewsSearch, NzbGuiPanel

public interface MimePlugin
extends CoffeeExchange

Interface for defining MimePlugins

Version:

$Revision: 1.4 $ $Date: 2010/12/30 04:42:46 $

Author:

dennis@brains2b.nl

Method Summary

void	close() close is called before the application is closed and with only the FileConnector available to handle events
java.lang.String	getDescription() get description for this plugin, used as tooltip
java.lang.String	getShortTitle() get short title on which this plugin is known
boolean	isActionSupported(java.lang.String mime, int eventID) check if the plugin supports the particular eventID for this MimeType
void	open() open is called after instantiation and before using the plugin

Methods inherited from interface org.brains2b.coffee.event.CoffeeExchange

setCurrentMessage

Method Detail

isActionSupported

boolean isActionSupported(java.lang.String mime,
                          int eventID)

check if the plugin supports the particular eventID for this MimeType

Parameters:

mime - String, the name of the mime-type

eventID - int, the CoffeeEvent id to support

Returns:

boolean, true if this plugin supports the action on the mime-type false otherwise

getShortTitle

java.lang.String getShortTitle()

get short title on which this plugin is known

Returns:

String

open

void open()

open is called after instantiation and before using the plugin

See Also:

MimeHandler

close

void close()

close is called before the application is closed and with only the FileConnector available to handle events

See Also:

MimeHandler

getDescription

java.lang.String getDescription()

get description for this plugin, used as tooltip

Returns:

String