net.sf.gridarta.plugin.PluginExecutor< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R > Class Template Reference

Allows execution of Plugins. More...

Collaboration diagram for net.sf.gridarta.plugin.PluginExecutor< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >:

Public Member Functions
BshThread< G, A, R >	doRunPlugin (@NotNull final Plugin< G, A, R > plugin, @NotNull final ConsoleInterface console, @NotNull final Map< String, Object > parameters)
	Runs a plugin model. More...
int	executePlugin (@NotNull final String plugin, @NotNull final Iterable< String > parameters)
	Executes an editor plugin. More...
	PluginExecutor (@NotNull final PluginModel< G, A, R > pluginModel, @NotNull final PluginParameters pluginParameters)
	Creates a new instance. More...

Private Attributes
final PluginModel< G, A, R >	pluginModel
	The PluginModel to execute. More...
final PluginParameters	pluginParameters
	The parameters to pass to the plugin. More...

Detailed Description

Allows execution of Plugins.

Author

Andreas Kirschbaum

Definition at line 47 of file PluginExecutor.java.

Constructor & Destructor Documentation

PluginExecutor()

net.sf.gridarta.plugin.PluginExecutor< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.PluginExecutor	(	@NotNull final PluginModel< G, A, R >	pluginModel,
		@NotNull final PluginParameters	pluginParameters
	)

Creates a new instance.

Parameters

pluginModel	the plugin model to execute
pluginParameters	the parameters to pass to the plugin

Definition at line 66 of file PluginExecutor.java.

Member Function Documentation

doRunPlugin()

BshThread<G, A, R> net.sf.gridarta.plugin.PluginExecutor< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doRunPlugin	(	@NotNull final Plugin< G, A, R >	plugin,
		@NotNull final ConsoleInterface	console,
		@NotNull final Map< String, Object >	parameters
	)

Runs a plugin model.

Parameters

plugin	the plugin model
console	the console to use
parameters	the parameters to pass to the plugin

Returns

the thread executing the script

Definition at line 193 of file PluginExecutor.java.

References net.sf.gridarta.plugin.PluginRunMode.BATCH, and net.sf.gridarta.plugin.PluginParameters.setInterpreterValues().

Here is the call graph for this function:

executePlugin()

int net.sf.gridarta.plugin.PluginExecutor< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.executePlugin	(	@NotNull final String	plugin,
		@NotNull final Iterable< String >	parameters
	)

Executes an editor plugin.

Parameters

plugin	the plugin name to execute
parameters	the plugin parameters

Returns

whether an error occurred

Definition at line 77 of file PluginExecutor.java.

References net.sf.gridarta.plugin.Plugin< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.clonePlugin(), net.sf.gridarta.plugin.parameter.PluginParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R, V >.getName(), net.sf.gridarta.plugin.Plugin< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getParameter(), net.sf.gridarta.plugin.PluginModel< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getPlugin(), net.sf.gridarta.plugin.BshThread< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.isSuccess(), net.sf.gridarta.utils.StringUtils.PATTERN_EQUAL, and net.sf.gridarta.plugin.parameter.PluginParameter< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R, V >.setStringValue().

Here is the call graph for this function:

Member Data Documentation

pluginModel

final PluginModel<G, A, R> net.sf.gridarta.plugin.PluginExecutor< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.pluginModel

private

The PluginModel to execute.

Definition at line 53 of file PluginExecutor.java.

pluginParameters

final PluginParameters net.sf.gridarta.plugin.PluginExecutor< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.pluginParameters

private

The parameters to pass to the plugin.

Definition at line 59 of file PluginExecutor.java.

---

The documentation for this class was generated from the following file:

• gridarta-gridarta/src/plugin/src/main/java/net/sf/gridarta/plugin/PluginExecutor.java