com.zphinx.spine.plugin
Class AbstractSpinePlugin

java.lang.Object
  extended by com.zphinx.spine.plugin.AbstractSpinePlugin
All Implemented Interfaces:
SpinePlugin
Direct Known Subclasses:
MessagePlugin

public abstract class AbstractSpinePlugin
extends Object
implements SpinePlugin

AbstractSpinePlugin is a base plugin useful for creating other plugins, a client developer should extend this class when creating a new plugin

Version:
$1.0

Copyright ©Zphinx Software Solutions

Author:
David Ladapo

Constructor Summary
AbstractSpinePlugin()
          Public Constructor
 
Method Summary
 String getName()
          Gets the name of this plugin
abstract  void process(Map map)
          The process method acts as a gateway to pass information to this adaptee and a means of providing extra functionality to the framework at initialization.
 void setName(String name)
          Sets the name
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractSpinePlugin

public AbstractSpinePlugin()
Public Constructor

Method Detail

getName

public String getName()
Description copied from interface: SpinePlugin
Gets the name of this plugin

Specified by:
getName in interface SpinePlugin
Returns:
The indentifier given to this object at initialization time

process

public abstract void process(Map map)
                      throws Throwable
Description copied from interface: SpinePlugin
The process method acts as a gateway to pass information to this adaptee and a means of providing extra functionality to the framework at initialization.

Specified by:
process in interface SpinePlugin
Parameters:
map - The map containing our configuration parameters.
Throws:
Throwable

setName

public void setName(String name)
Sets the name

Specified by:
setName in interface SpinePlugin
Parameters:
name - the name to set