org.zimowski.bambi.editor.plugins.api

Class AbstractPlugin

java.lang.Object

javax.swing.SwingWorker<Void,Void>

org.zimowski.bambi.editor.plugins.api.AbstractPlugin

All Implemented Interfaces:

Runnable, Future<Void>, RunnableFuture<Void>, Plugin

Direct Known Subclasses:

AbstractImagePlugin, AbstractPluginAdapter

public abstract class AbstractPlugin
extends SwingWorker<Void,Void>
implements Plugin

Raw plugin base with configuration support. All plugins must be instances of SwingWorker due to their unpredictable nature, so the support for executing off the UI thread is built-in. That does not mean that plugin is forced to utilize worker thread if it's operation is fast enough as to not block the UI, though in general it is recommended a plugin does utilize worker facilities. To run off the EDT a plugin must define its logic inside SwingWorker.doInBackground() (by overriding empty implementation), plus optionally SwingWorker.done(), and call SwingWorker.execute() from main plugin interface entry point. If a plugin is not utilizing non-blocking UI thread (wants to run ON the EDT), then it should derive from AbstractPluginAdapter instead simply implementing its logic directly in its interface entry point.

Author:

Adam Zimowski (mrazjava)

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.SwingWorker

SwingWorker.StateValue

Field Summary

Fields

Modifier and Type	Field and Description
protected Properties	configuration

Constructor Summary

Constructors

Constructor and Description
AbstractPlugin()

Method Summary

Methods

Modifier and Type	Method and Description
void	initialize(Properties configuration) Typically called immediately after instantiation to allow the plugin proper initialization and certainly before its invocation.

Methods inherited from class javax.swing.SwingWorker

addPropertyChangeListener, cancel, doInBackground, done, execute, firePropertyChange, get, get, getProgress, getPropertyChangeSupport, getState, isCancelled, isDone, process, publish, removePropertyChangeListener, run, setProgress

Methods inherited from class java.lang.Object

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

Field Detail

configuration

protected Properties configuration

Constructor Detail

AbstractPlugin

public AbstractPlugin()

Method Detail

initialize

public void initialize(Properties configuration)

Description copied from interface: Plugin

Typically called immediately after instantiation to allow the plugin proper initialization and certainly before its invocation. Since plugin configuration is custom defined (cannot be known at compile time), it must follow specific naming convention in order to be properly loaded. Plugin setting must begin with the name of the plugin setting itself, followed by a separator. For example, the ConfigParameters.IMAGE_EXPORT_PLUGIN is used to define the image upload strategy by specifying plugin's full class path. Configuration settings for that plugin can be named freely but must be prefixed with the plugin setting itself followed by ConfigLoader.PARAM_SEPARATOR. Another example: say fooPlug is the setting for com.foo.Plug. Configuration setting bar for fooPlug would would be defined as fooPlug.bar if dot is ConfigLoader.PARAM_SEPARATOR.

Specified by:

initialize in interface Plugin

Parameters:

configuration - plugin settings defined in the configuration file