Class PluginEntryPointRunner

java.lang.Object

ca.phon.plugin.PluginEntryPointRunner

public class PluginEntryPointRunner
extends Object

Methods for executing plugin entry points using various methods.

Constructor Summary

Constructors

Constructor	Description
PluginEntryPointRunner(IPluginEntryPoint ep)	Constructor.
PluginEntryPointRunner(IPluginEntryPoint ep, Map<String,Object> args)	Constructor.
PluginEntryPointRunner(String epName)	Constructor
PluginEntryPointRunner(String epName, Map<String,Object> args)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	executePlugin()	Execute plugin on calling thread.
static IPluginEntryPoint	executePlugin(IPluginEntryPoint ep)
static IPluginEntryPoint	executePlugin(IPluginEntryPoint ep, Map<String,Object> args)
static IPluginEntryPoint	executePlugin(String epName)
static IPluginEntryPoint	executePlugin(String epName, Map<String,Object> args)
ca.phon.plugin.PluginEntryPointRunner.PluginEntryPointTask	executePluginInBackground()	Execute plugin on the default background thread.
static ca.phon.plugin.PluginEntryPointRunner.PluginEntryPointTask	executePluginInBackground(IPluginEntryPoint ep)
static ca.phon.plugin.PluginEntryPointRunner.PluginEntryPointTask	executePluginInBackground(IPluginEntryPoint ep, Map<String,Object> args)
static ca.phon.plugin.PluginEntryPointRunner.PluginEntryPointTask	executePluginInBackground(String epName)
static ca.phon.plugin.PluginEntryPointRunner.PluginEntryPointTask	executePluginInBackground(String epName, Map<String,Object> args)
PhonTask	executePluginOnNewThread()	Execute plugin a new thread
static PhonTask	executePluginOnNewThread(IPluginEntryPoint ep)
static PhonTask	executePluginOnNewThread(IPluginEntryPoint ep, Map<String,Object> args)
static PhonTask	executePluginOnNewThread(String epName)
static PhonTask	executePluginOnNewThread(String epName, Map<String,Object> args)
static PhonTask	executePluginOnThread(IPluginEntryPoint ep, PhonWorker thread)
static PhonTask	executePluginOnThread(IPluginEntryPoint ep, Map<String,Object> args, PhonWorker thread)
PhonTask	executePluginOnThread(PhonWorker thread)	Execute plugin on the given worker thread.
static PhonTask	executePluginOnThread(String epName, PhonWorker thread)
static PhonTask	executePluginOnThread(String epName, Map<String,Object> args, PhonWorker thread)
Map<String,Object>	getArgs()
IPluginEntryPoint	getEp()
void	setArgs(Map<String,Object> args)
void	setEp(IPluginEntryPoint ep)

Methods inherited from class java.lang.Object

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

Constructor Details

PluginEntryPointRunner

public PluginEntryPointRunner(String epName)

Constructor

Parameters:

epName -

PluginEntryPointRunner

public PluginEntryPointRunner(String epName,
 Map<String,Object> args)

Constructor.

Parameters:

epName -

args -

PluginEntryPointRunner

public PluginEntryPointRunner(IPluginEntryPoint ep)

Constructor.

Parameters:

ep -

PluginEntryPointRunner

public PluginEntryPointRunner(IPluginEntryPoint ep,
 Map<String,Object> args)

Constructor.

Parameters:

ep -

args -

Method Details

getEp

public IPluginEntryPoint getEp()

setEp

public void setEp(IPluginEntryPoint ep)

getArgs

public Map<String,Object> getArgs()

setArgs

public void setArgs(Map<String,Object> args)

executePlugin

public void executePlugin()
                   throws PluginException

Execute plugin on calling thread. Calling thread will be blocked until pluginStart is finished.

Throws:

PluginException

executePlugin

public static IPluginEntryPoint executePlugin(IPluginEntryPoint ep)
                                       throws PluginException

Throws:

PluginException

executePlugin

public static IPluginEntryPoint executePlugin(String epName)
                                       throws PluginException

Throws:

PluginException

executePlugin

public static IPluginEntryPoint executePlugin(IPluginEntryPoint ep,
 Map<String,Object> args)
                                       throws PluginException

Throws:

PluginException

executePlugin

public static IPluginEntryPoint executePlugin(String epName,
 Map<String,Object> args)
                                       throws PluginException

Throws:

PluginException

executePluginInBackground

public ca.phon.plugin.PluginEntryPointRunner.PluginEntryPointTask executePluginInBackground()

Execute plugin on the default background thread.

Returns:

the plugin task

executePluginInBackground

public static ca.phon.plugin.PluginEntryPointRunner.PluginEntryPointTask executePluginInBackground(String epName)

executePluginInBackground

public static ca.phon.plugin.PluginEntryPointRunner.PluginEntryPointTask executePluginInBackground(String epName,
 Map<String,Object> args)

executePluginInBackground

public static ca.phon.plugin.PluginEntryPointRunner.PluginEntryPointTask executePluginInBackground(IPluginEntryPoint ep)

executePluginInBackground

public static ca.phon.plugin.PluginEntryPointRunner.PluginEntryPointTask executePluginInBackground(IPluginEntryPoint ep,
 Map<String,Object> args)

executePluginOnThread

public PhonTask executePluginOnThread(PhonWorker thread)

Execute plugin on the given worker thread.

Parameters:

thread -

Returns:

the plugin task

executePluginOnThread

public static PhonTask executePluginOnThread(String epName,
 PhonWorker thread)

executePluginOnThread

public static PhonTask executePluginOnThread(String epName,
 Map<String,Object> args,
 PhonWorker thread)

executePluginOnThread

public static PhonTask executePluginOnThread(IPluginEntryPoint ep,
 PhonWorker thread)

executePluginOnThread

public static PhonTask executePluginOnThread(IPluginEntryPoint ep,
 Map<String,Object> args,
 PhonWorker thread)

executePluginOnNewThread

public PhonTask executePluginOnNewThread()

Execute plugin a new thread

Returns:

the plugin task

executePluginOnNewThread

public static PhonTask executePluginOnNewThread(String epName)

executePluginOnNewThread

public static PhonTask executePluginOnNewThread(String epName,
 Map<String,Object> args)

executePluginOnNewThread

public static PhonTask executePluginOnNewThread(IPluginEntryPoint ep)

executePluginOnNewThread

public static PhonTask executePluginOnNewThread(IPluginEntryPoint ep,
 Map<String,Object> args)