icy.plugin

Class PluginLauncher

java.lang.Object

icy.plugin.PluginLauncher

public class PluginLauncher
extends java.lang.Object

This class launch plugins and register them to the main application.
The launch can be in a decicated thread or in the EDT.

Author:

Fabrice de Chaumont & Stephane

Constructor Summary

Constructors

Constructor and Description
PluginLauncher()

Method Summary

Methods

Modifier and Type	Method and Description
static Plugin	create(PluginDescriptor plugin) Creates a new instance of the specified plugin and returns it.
static Plugin	create(PluginDescriptor plugin, boolean register) Creates a new instance of the specified plugin and returns it.
static void	launch(PluginDescriptor descriptor) Deprecated. Use start(PluginDescriptor) instead.
static Plugin	start(PluginDescriptor plugin) Starts the specified plugin (catched exception version).
static Plugin	start(java.lang.String pluginClassName) Deprecated. Use start(PluginDescriptor) instead. You can retrieve a PluginDescriptor from the class name by using PluginLoader.getPlugin(String) method.
static Plugin	startSafe(PluginDescriptor plugin) Same as start(PluginDescriptor) except it throws Exception on error so user can handle them.
static Plugin	startSafe(java.lang.String pluginClassName) Deprecated. Use startSafe(PluginDescriptor) instead. You can retrieve a PluginDescriptor from the class name by using PluginLoader.getPlugin(String) method.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginLauncher

public PluginLauncher()

Method Detail

create

public static Plugin create(PluginDescriptor plugin,
            boolean register)
                     throws java.lang.Exception

Creates a new instance of the specified plugin and returns it.

Parameters:

plugin - descriptor of the plugin we want to create an instance for

register - if we want to register the plugin in the active plugin list

Throws:

java.lang.Exception

See Also:

startSafe(PluginDescriptor)

create

public static Plugin create(PluginDescriptor plugin)
                     throws java.lang.Exception

Creates a new instance of the specified plugin and returns it.
The plugin is automatically registered to the list of active plugins.

Parameters:

plugin - descriptor of the plugin we want to create an instance for

Throws:

java.lang.Exception

See Also:

startSafe(PluginDescriptor)

start

public static Plugin start(PluginDescriptor plugin)

Starts the specified plugin (catched exception version).
Returns the plugin instance (only meaningful for PluginThreaded plugin) or null if an error occurred.

Parameters:

plugin - descriptor of the plugin we want to start

See Also:

startSafe(PluginDescriptor)

start

@Deprecated
public static Plugin start(java.lang.String pluginClassName)

Deprecated. Use start(PluginDescriptor) instead.
You can retrieve a PluginDescriptor from the class name by using PluginLoader.getPlugin(String) method.

startSafe

public static Plugin startSafe(PluginDescriptor plugin)
                        throws java.lang.Exception

Same as start(PluginDescriptor) except it throws Exception on error so user can handle them.

Parameters:

plugin - descriptor of the plugin we want to start compatibility)

Throws:

java.lang.InterruptedException - if the current thread was interrupted while waiting for execution on EDT.

java.lang.Exception - if the computation threw an exception (only when plugin is executed on EDT).

startSafe

@Deprecated
public static Plugin startSafe(java.lang.String pluginClassName)
                        throws java.lang.Exception

Deprecated. Use startSafe(PluginDescriptor) instead.
You can retrieve a PluginDescriptor from the class name by using PluginLoader.getPlugin(String) method.

Throws:

java.lang.Exception

launch

@Deprecated
public static void launch(PluginDescriptor descriptor)

Deprecated. Use start(PluginDescriptor) instead.