com.eteks.sweethome3d.plugin
Class PluginManager

java.lang.Object
  com.eteks.sweethome3d.plugin.PluginManager

public class PluginManager
extends Object

Sweet Home 3D plug-ins manager.

Author:

Emmanuel Puybaret

Field Summary

static String

PLUGIN_LIBRARY_TYPE

Constructor Summary

PluginManager(File pluginFolder)
Reads application plug-ins from resources in the given plug-in folder.

PluginManager(File[] pluginFolders)
Reads application plug-ins from resources in the given plug-in folders.

PluginManager(URL[] pluginUrls)
Reads application plug-ins from resources in the given URLs.

Method Summary

void	addPlugin(String pluginPath) Adds the file at the given location to the first plug-ins folders if it exists.
void	deletePlugins(List<Library> libraries) Deletes the given plug-in libraries from managed plug-ins.
List<Library>	getPluginLibraries() Returns the available plug-in libraries.
List<Plugin>	getPlugins(HomeApplication application, Home home, UserPreferences preferences, UndoableEditSupport undoSupport) Returns an unmodifiable list of plug-in instances initialized with the given parameters.
boolean	pluginExists(String pluginLocation) Returns true if a plug-in in the given file name already exists in the first plug-ins folder.

Methods inherited from class java.lang.Object

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

Field Detail

PLUGIN_LIBRARY_TYPE

public static final String PLUGIN_LIBRARY_TYPE

See Also:

Constant Field Values

Constructor Detail

PluginManager

public PluginManager(File pluginFolder)

Reads application plug-ins from resources in the given plug-in folder.

PluginManager

public PluginManager(File[] pluginFolders)

Reads application plug-ins from resources in the given plug-in folders.

Since:

3.0

PluginManager

public PluginManager(URL[] pluginUrls)

Reads application plug-ins from resources in the given URLs.

Method Detail

getPluginLibraries

public List<Library> getPluginLibraries()

Returns the available plug-in libraries.

Since:

4.0

getPlugins

public List<Plugin> getPlugins(HomeApplication application,
                               Home home,
                               UserPreferences preferences,
                               UndoableEditSupport undoSupport)

Returns an unmodifiable list of plug-in instances initialized with the given parameters.

pluginExists

public boolean pluginExists(String pluginLocation)
                     throws RecorderException

Returns true if a plug-in in the given file name already exists in the first plug-ins folder.

Throws:

RecorderException - if no plug-ins folder is associated to this manager.

deletePlugins

public void deletePlugins(List<Library> libraries)
                   throws RecorderException

Deletes the given plug-in libraries from managed plug-ins.

Throws:

RecorderException

Since:

4.0

addPlugin

public void addPlugin(String pluginPath)
               throws RecorderException

Adds the file at the given location to the first plug-ins folders if it exists. Once added, the plug-in will be available at next application start.

Throws:

RecorderException - if no plug-ins folder is associated to this manager.