Package dk.gtz.graphedit.spi

Interface IPlugin

public interface IPlugin
Base interface for a third-party plugin. Each plugin must implement this to be discoverable by the plugin loader.

  • Method Details

    • getName

      String getName()
      Get the name of this plugin. Should try to be unique
      Returns:
      The name of this plugin implementation

    • getDescription

      default String getDescription()
      Get a general description of this plugin
      Returns:
      A description of what kinds of utilities this plugin provides

    • onInitialize

      default void onInitialize()
      Event called when the plugin is initialized (before any syntax factories or panels are requested) At this point, only some things are registered in DI.

    • onStart

      default void onStart()
      Event called when the application has loaded. At this point, most things are registered in DI.

    • onDestroy

      default void onDestroy()
      Event called when the plugin is disabled by the user. Use this to clean up any processed or resources that has been loaded.

    • getSyntaxFactories

      default Collection<ISyntaxFactory> getSyntaxFactories() throws Exception
      Get a collection of syntax factories provided by this plugin. Will return an empty list by default.
      Returns:
      A collection of syntax factories
      Throws:
      Exception - Allowed to throw any kind of exception. See the specific plugin implementation for details

    • getPanels

      default Collection<IPluginPanel> getPanels() throws Exception
      Get a collection of panels provided by this plugin. Will return an empty list by default.
      Returns:
      A collection of plugin panels
      Throws:
      Exception - Allowed to throw any kind of exception. See the specific plugin implementation for details

    • getLanguageServers

      default Collection<ILanguageServer> getLanguageServers() throws Exception
      Get a collection of language servers provided by this plugin. Will return an empty list by default.
      Returns:
      A collection of language servers
      Throws:
      Exception - Allowed to throw any kind of exception. See the specific plugin implementation for details

    • getImporters

      default Collection<IImporter> getImporters()
      Get a collection of importers provided by this plugin. Will return an empty list by default.
      Returns:
      A collection of importers

    • getExporters

      default Collection<IExporter> getExporters()
      Get a collection of exporters provided by this plugin. Will return an empty list by default.
      Returns:
      A collection of exporters