Package net.storm.api.plugins.config

Interface SearchablePlugin

All Known Implementing Classes:
PluginListItem
public interface SearchablePlugin
Interface for plugins that can be searched in the plugin list.

SearchablePlugin defines the contract for plugins to provide search metadata, including their searchable name, keywords, and sorting hints like pinned status and install count.

See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    List<String>
    getKeywords()
    Gets the keywords for search matching.
    String
    getSearchableName()
    Gets the name used for search matching.
    default int
    installs()
    Gets the install count for popularity-based sorting.
    default boolean
    isPinned()
    Checks if this plugin is pinned to the top of the list.

  • Method Details

    • getSearchableName

      String getSearchableName()
      Gets the name used for search matching.

      This is typically the plugin's display name.

      Returns:
      the searchable name

    • getKeywords

      List<String> getKeywords()
      Gets the keywords for search matching.

      Keywords should include the plugin name, description words, and tags to enable comprehensive search functionality.

      Returns:
      a list of search keywords

    • isPinned

      default boolean isPinned()
      Checks if this plugin is pinned to the top of the list.

      Pinned plugins appear first in search results and the default list view.

      Returns:
      true if pinned, false otherwise (default)

    • installs

      default int installs()
      Gets the install count for popularity-based sorting.

      Higher values indicate more popular plugins and rank higher in search results.

      Returns:
      the number of installs, or 0 if unknown (default)