Package org.pf4j

Class Plugin

java.lang.Object
org.pf4j.Plugin

public class Plugin extends Object
This class will be extended by all plugins and serve as the common class between a plugin and the application.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final org.slf4j.Logger
    Makes logging service available for descending classes.
    protected PluginWrapper
    Wrapper of the plugin.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Constructor to be used by plugin manager for plugin instantiation.
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    This method is called by the application when the plugin is deleted.
    Retrieves the wrapper of this plug-in.
    void
    This method is called by the application when the plugin is started.
    void
    This method is called by the application when the plugin is stopped.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • log

      protected final org.slf4j.Logger log
      Makes logging service available for descending classes.
    • wrapper

      protected PluginWrapper wrapper
      Wrapper of the plugin.
  • Constructor Details

    • Plugin

      public Plugin(PluginWrapper wrapper)
      Constructor to be used by plugin manager for plugin instantiation. Your plugins have to provide constructor with this exact signature to be successfully loaded by manager.
  • Method Details