Package com.velocitypowered.api.plugin.ap

Class SerializedPluginDescription

java.lang.Object
com.velocitypowered.api.plugin.ap.SerializedPluginDescription
public final class SerializedPluginDescription extends Object
Serialized version of PluginDescription.

  • Field Details

    • ID_PATTERN_STRING

      public static final String ID_PATTERN_STRING
      The string pattern used to validate plugin IDs.

      Plugin IDs must start with a lowercase letter and may contain lowercase letters, digits, hyphens, and underscores. The total length must not exceed 64 characters.

      See Also:

    • ID_PATTERN

      public static final Pattern ID_PATTERN
      The compiled pattern used to validate plugin IDs.

      Plugin IDs must start with a lowercase letter and may contain lowercase letters, digits, hyphens, and underscores. The total length must not exceed 64 characters.

  • Method Details

    • getId

      public String getId()
      Gets the ID of the plugin this dependency refers to.
      Returns:
      the plugin ID

    • getName

      public @Nullable String getName()
      Gets the human-readable name of the plugin.
      Returns:
      the plugin's name, or null if not specified

    • getVersion

      public @Nullable String getVersion()
      Gets the version string of the plugin.
      Returns:
      the plugin version, or null if not specified

    • getDescription

      public @Nullable String getDescription()
      Gets the plugin's description, typically a short summary of its functionality.
      Returns:
      the description, or null if not specified

    • getUrl

      public @Nullable String getUrl()
      Gets the website URL for the plugin.

      This is often used to link to documentation, support, or the plugin's homepage.

      Returns:
      the plugin URL, or null if not specified

    • getAuthors

      public List<String> getAuthors()
      Gets the list of authors who contributed to the plugin.
      Returns:
      an immutable list of authors; empty if none were specified

    • getDependencies

      public List<SerializedPluginDescription.Dependency> getDependencies()
      Gets the list of declared dependencies for the plugin.

      Dependencies may be required or optional and describe other plugins, this one depends.

      Returns:
      an immutable list of plugin dependencies

    • getMain

      public String getMain()
      Gets the fully qualified name of the plugin's main class.
      Returns:
      the main class name

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object