public abstract class

AbstractEnginesPlugin

extends AbstractPlugin
implements IEnginesPlugin
java.lang.Object
   ↳ com.pnfsoftware.jeb.core.AbstractPlugin
     ↳ com.pnfsoftware.jeb.core.AbstractEnginesPlugin
Known Direct Subclasses

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 execute(IEnginesContext context)
List<? extends IOptionDefinition> getExecutionOptionDefinitions()
Retrieve a list of option definitions.
void load(IEnginesContext context)
Load the plugin.
[Expand]
Inherited Methods
From class com.pnfsoftware.jeb.core.AbstractPlugin
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 execute (IEnginesContext context)

Parameters
context the context in which this plugin executes (never null)

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)