public abstract class

AbstractEnginesPlugin

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

Class Overview

Skeleton implementation for engines plugins. It is recommended plugins extend this class or one of the its subclasses instead of implementing IEnginesPlugin. Please refer to IEnginesPlugin for notes and caveats.

Summary

Fields
public static final ILogger logger
Public Constructors
AbstractEnginesPlugin()
Public Methods
void execute(IEnginesContext context)
The default implementation forwards execution to execute(IEnginesContext, java.util.Map), without providing options.
List<? extends IOptionDefinition> getExecutionOptionDefinitions()
The default implementation returns null.
void load(IEnginesContext context)
The default implementation does nothing.
[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

Fields

public static final ILogger logger

Public Constructors

public AbstractEnginesPlugin ()

Public Methods

public void execute (IEnginesContext context)

The default implementation forwards execution to execute(IEnginesContext, java.util.Map), without providing options.

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

public List<? extends IOptionDefinition> getExecutionOptionDefinitions ()

The default implementation returns null.

Returns
  • optional list of option definitions

public void load (IEnginesContext context)

The default implementation does nothing.

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