Package repast.simphony.util.wizard

Class WizardPluginUtil

java.lang.Object

repast.simphony.util.wizard.WizardPluginUtil

public class WizardPluginUtil
extends Object

Utilities for working with plugin-able wizards. This helps in loading settings for a wizard whose options are loaded from plugin descriptions (plugin.xml's).

Author:

Jerry Vos

See Also:

WizardOption

Field Summary

Fields

Modifier and Type	Field	Description
static String	CLASS_KEY

Constructor Summary

Constructors

Constructor	Description
WizardPluginUtil()

Method Summary

Modifier and Type	Method	Description
static <T extends WizardOption> List<T>	loadWizardOptions(org.java.plugin.PluginManager manager, Class<T> baseOptionClass, String extensionPointPluginId, String extensionPointId, boolean register)	Retrieves WizardOptions of the specified type from the plugin manager.

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_KEY

public static final String CLASS_KEY

See Also:

Constant Field Values

Constructor Detail

WizardPluginUtil

public WizardPluginUtil()

Method Detail

loadWizardOptions

public static <T extends WizardOption> List<T> loadWizardOptions(org.java.plugin.PluginManager manager,
                                                                 Class<T> baseOptionClass,
                                                                 String extensionPointPluginId,
                                                                 String extensionPointId,
                                                                 boolean register)

Retrieves WizardOptions of the specified type from the plugin manager. The options are read in from the specified plugin and extension point. The extension point is assumed to contain a class field (CLASS_KEY) that specifies the class of the wizard option.

If the register option is true, this will register the loaded options into the DynamicWizard with the extensionPointId as the wizardId.

Parameters:

manager - the plugin manager that the extension points will be retrieved from

baseOptionClass - the option class (cannot be null as it is used for casting)

extensionPointPluginId - the id of the plugin that the extension point is declared in

extensionPointId - the id of the extension point that the wizard options will be registered to

register - whether or not to register the loaded plugins to the DynamicWizard

Returns:

all the options that could be instantiated from the specified point

See Also:

DynamicWizard.registerWizardOption(String, WizardOption)