| java.lang.Object | |
| ↳ | com.pnfsoftware.jeb.core.AbstractEnginesPlugin |
Class Overview
Skeleton implementation for an engines plugin. It is recommended plugins
extend this class (or one of the its subclasses) instead of implementing IEnginesPlugin.
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| AbstractEnginesPlugin() | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| void |
dispose()
Dispose of resources used by this plugin.
| ||||||||||
| void |
execute(IEnginesContext context)
Same as
execute(context, null). | ||||||||||
| Object |
getData(Object key)
Retrieve a piece of transient plugin data.
| ||||||||||
| List<? extends IOptionDefinition> |
getExecutionOptionDefinitions()
Retrieve a list of option definitions.
| ||||||||||
| void |
load(IEnginesContext context)
Load the plugin.
| ||||||||||
| void |
setData(Object key, Object value)
Store a piece of transient plugin data.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
|
From interface
com.pnfsoftware.jeb.core.IEnginesPlugin
| |||||||||||
|
From interface
com.pnfsoftware.jeb.core.IPlugin
| |||||||||||
Public Constructors
public AbstractEnginesPlugin ()
Public Methods
public void dispose ()
Dispose of resources used by this plugin. The engines context calls this method upon plugin unloading.
public void execute (IEnginesContext context)
Same as execute(context, null).
Parameters
| context | the context in which this plugin executes (never null) |
|---|
public Object getData (Object key)
Retrieve a piece of transient plugin data.
public List<? extends IOptionDefinition> getExecutionOptionDefinitions ()
Retrieve a list of option definitions.
Returns
- optional list of option definitions
public void load (IEnginesContext context)
Load the plugin. This method is called by the owner context exactly
once, just after the engines plugin instantiation.
Parameters
| context | the context in which this plugin executes (never null) |
|---|
public void setData (Object key, Object value)
Store a piece of transient plugin data.