Package net.md_5.bungee.api.plugin

Class PluginDescription

java.lang.Object
net.md_5.bungee.api.plugin.PluginDescription
public class PluginDescription extends Object
POJO representing the plugin.yml file.

  • Constructor Details

  • Method Details

    • getName

      public String getName()
      Friendly name of the plugin.

    • getMain

      public String getMain()
      Plugin main class. Needs to extend Plugin.

    • getVersion

      public String getVersion()
      Plugin version.

    • getAuthor

      public String getAuthor()
      Plugin author.

    • getDepends

      public Set<String> getDepends()
      Plugin hard dependencies.

    • getSoftDepends

      public Set<String> getSoftDepends()
      Plugin soft dependencies.

    • getFile

      public File getFile()
      File we were loaded from.

    • getDescription

      public String getDescription()
      Optional description.

    • getLibraries

      public List<String> getLibraries()
      Optional libraries.

    • getExcludedTransitiveLibraries

      public List<String> getExcludedTransitiveLibraries()
      Optional: libraries to be excluded from download. A clear example is having 2 versions of the same library. This can be achieved by having a library which packs a library the plugin already packs via getLibraries() and suddenly, BungeeCord ends up with 2 different versions of the same library, when there can be 1! Or another hilarious case: having a download of a library, already packed in the BungeeCord jar!

      Syntax is the same as in getLibraries()

    • setName

      public void setName(String name)
      Friendly name of the plugin.

    • setMain

      public void setMain(String main)
      Plugin main class. Needs to extend Plugin.

    • setVersion

      public void setVersion(String version)
      Plugin version.

    • setAuthor

      public void setAuthor(String author)
      Plugin author.

    • setDepends

      public void setDepends(Set<String> depends)
      Plugin hard dependencies.

    • setSoftDepends

      public void setSoftDepends(Set<String> softDepends)
      Plugin soft dependencies.

    • setFile

      public void setFile(File file)
      File we were loaded from.

    • setDescription

      public void setDescription(String description)
      Optional description.

    • setLibraries

      public void setLibraries(List<String> libraries)
      Optional libraries.

    • setExcludedTransitiveLibraries

      public void setExcludedTransitiveLibraries(List<String> excludedTransitiveLibraries)
      Optional: libraries to be excluded from download. A clear example is having 2 versions of the same library. This can be achieved by having a library which packs a library the plugin already packs via getLibraries() and suddenly, BungeeCord ends up with 2 different versions of the same library, when there can be 1! Or another hilarious case: having a download of a library, already packed in the BungeeCord jar!

      Syntax is the same as in getLibraries()

    • equals

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

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object