Package eu.rarogsoftware.rarog.platform.api.plugins

Record Class PluginManifest

java.lang.Object
java.lang.Record
eu.rarogsoftware.rarog.platform.api.plugins.PluginManifest
Record Components:
key - unique plugin key - plugins with the same key are recognized as different version of the same plugin
name - human-readable plugin name
version - plugin version
description - human-readable plugin description
image - url to image to be shown in list of plugins
public record PluginManifest(String key, String name, String version, String description, String image) extends Record
Object representing plugin manifest that contains basic info about plugin.

  • Constructor Details

    • PluginManifest

      public PluginManifest(String key, String name, String version, String description, String image)
      Creates an instance of a PluginManifest record class.
      Parameters:
      key - the value for the key record component
      name - the value for the name record component
      version - the value for the version record component
      description - the value for the description record component
      image - the value for the image record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • key

      public String key()
      Returns the value of the key record component.
      Returns:
      the value of the key record component

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • version

      public String version()
      Returns the value of the version record component.
      Returns:
      the value of the version record component

    • description

      public String description()
      Returns the value of the description record component.
      Returns:
      the value of the description record component

    • image

      public String image()
      Returns the value of the image record component.
      Returns:
      the value of the image record component