Package io.gdcc.spi.meta.plugin

Interface Plugin

All Known Subinterfaces:
Exporter, XMLExporter
public interface Plugin
Represents the contract for plugins in the system. Implementations of this interface serve as modular components that can be dynamically loaded and integrated into the broader application. Each plugin must provide a unique, machine-readable identifier to ensure proper identification and usage within the system. Implementers are required to define the identity() method to specify their unique identifier.
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    identity()
    Returns the unique, machine-readable identifier for this plugin.

  • Method Details

    • identity

      String identity()
      Returns the unique, machine-readable identifier for this plugin. This will be the primary key within the core to identify a specific plugin implementation.
      Returns:
      the plugin's identity string, which must be non-null, non-blank, and URL compatible.
      Implementation Requirements:
      This method must be overridden by any plugin implementation and return a non-null, non-blank, URL-compatible string. No plugin interface may provide a default implementation.