Interface PluginMetadata

public interface PluginMetadata
Interface defining the core properties/information about the plugin

  • Method Summary

    Modifier and Type
    Method
    Description
    default @NotNull String[]
    getAuthor()
    A String containing a list of all authors for this
    May be empty, but may not be null
    default String
    getDescription()
    Description for the tool, shuld be an explanatory, yet simple description
    @NotNull String
    getName()
    Returns the name of the plugin
    @NotNull String
    getVersion()
    Version of the project

  • Method Details

    • getName

      @NotNull @NotNull String getName()
      Returns the name of the plugin
      Returns:
      String containing the name

    • getVersion

      @NotNull @NotNull String getVersion()
      Version of the project
      Returns:
      String returning the version, expected format Major.Minor.Path see semver.org

    • getDescription

      default String getDescription()
      Description for the tool, shuld be an explanatory, yet simple description
      Returns:
      String containing the description

    • getAuthor

      @NotNull default @NotNull String[] getAuthor()
      A String containing a list of all authors for this
      May be empty, but may not be null
      Returns: