Package org.jorigin.plugin

Interface IPlugin

  • public interface IPlugin
    This interface represent an application plugin. An aplication plugin enable to extends an application with various functions. The plugin interface specifies the method necessary to the plugin manager for managing the plugin.
    Since:
    1.0.0
    Version:
    "1.0.9" - b201903071030L
    Author:
    Julien Seinturier - COMEX S.A. - contact@jorigin.org - https://github.com/jorigin/jeometry

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int PLUGIN_INITIALIZED
      Final identifier for the plugin state corresponding to initialized.
      static int PLUGIN_STARTED
      Identifier for the plugin state corresponding to started.

    • Method Detail

      • pluginInit

        boolean pluginInit​(IPlugger plugger)
            throws java.lang.Exception
        Init the plugin and give the plugin a reference to the plugger where it is registered.
        Parameters:
        plugger - plugger the reference to the plugger
        Returns:
        true if the plugin is correctly initialized, false otherwise.
        Throws:
        java.lang.Exception - if an error occurs.

      • pluginStart

        boolean pluginStart()
        Method called when the plugger starts the plugin
        Returns:
        true if the plugin is started, false otherwise.

      • pluginStop

        boolean pluginStop()
        Method called when the plugger stop the plugin
        Returns:
        true if the plugin is stopped, false otherwise.

      • getName

        java.lang.String getName()
        Get the name of the plugin. The name must be unique. The canonical name of the plugin class can be used.
        Returns:
        the name of the plugin.

      • getDependencies

        java.lang.String[] getDependencies()
        Return the dependencies of the plugin. Dependencies are represented by the name of the required plugins to make this plugin to work.
        Returns:
        An array of plugin names.

      • isPluginInitialized

        boolean isPluginInitialized()
        Return true if the plugin is initialized.
        Returns:
        true if the plugin is initialized, false otherwise.

      • isPluginStarted

        boolean isPluginStarted()
        Return true if the plugin is started, false otherwise.
        Returns:
        true if the plugin is started, false otherwise.