Package com.velocitypowered.api.plugin.ap

Class SerializedPluginDescription.Dependency

java.lang.Object
com.velocitypowered.api.plugin.ap.SerializedPluginDescription.Dependency
Enclosing class:
SerializedPluginDescription
public static final class SerializedPluginDescription.Dependency extends Object
Represents a dependency declared by a plugin.

A dependency consists of an identifier (typically the plugin ID) and a flag indicating whether the dependency is optional. Required dependencies must be present for the plugin to load, whereas optional dependencies may or may not be available at runtime.

  • Constructor Details

    • Dependency

      public Dependency(String id, boolean optional)
      Constructs a new dependency class.
      Parameters:
      id - the ID of the dependent plugin
      optional - whether the dependency is optional

  • Method Details

    • getId

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

    • isOptional

      public boolean isOptional()
      Indicates whether this dependency is optional.

      Optional dependencies are not required for the plugin to load.

      Returns:
      true if the dependency is optional; false otherwise

    • 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