com.prosyst.mprm.backend.script.plugin

Interface ParserPluginService

public interface ParserPluginService

This service can be used by applications, that want to define custom script commands.

Method Summary

Modifier and Type	Method and Description
void	addPlugin(java.lang.String pluginName, java.io.InputStream regEx, ScriptPlugin plugin) Adds a script plugin.
void	addPlugin(java.lang.String pluginName, java.lang.String regEx, ScriptPlugin plugin) Adds a script plugin.
void	removePlugin(java.lang.String pluginName) Removes a script plugin.

Method Detail

addPlugin

void addPlugin(java.lang.String pluginName,
               java.io.InputStream regEx,
               ScriptPlugin plugin)
        throws InvalidPluginException

Adds a script plugin.

Parameters:

pluginName - name of this plugin. All plugins are identified by their names. If a plugin with such name already exists, this method will remove it and replace it with the new one.

regEx - must represent a regular expression that defines lexical form of the newly defined script commands.

plugin - a ScrptPlugin object that shall provide semantic fro the newly defined script commands.

Throws:

InvalidPluginException - is thrown if the parameter regEx does not represent a correct regular expression, or if the commands defined by this regular expressions are in collision with already existing commands that have the same start.

InvalidPluginException

addPlugin

void addPlugin(java.lang.String pluginName,
               java.lang.String regEx,
               ScriptPlugin plugin)
        throws InvalidPluginException

Adds a script plugin.

Parameters:

pluginName - name of this plugin. All plugins are identified by their names If a plugin with such name already exists, this method shall remove it and replace it with the new one.

regEx - must represent a regular expression that defines lexical form of the newly defined script commands.

plugin - a ScrptPlugin object that shall provide semantic fro the newly defined script commands.

Throws:

InvalidPluginException - is thrown if the parameter regEx does not represent a correct regular expression, or if the commands defined by this regular expressions are in collision with already existing commands that have the same start.

InvalidPluginException

removePlugin

void removePlugin(java.lang.String pluginName)

Removes a script plugin. Commands defined by the specified plugin shall no longer be matched by the script parser.

Parameters:

pluginName - name of the plugin.