Package software.bluelib.api.event.mod

Record Class ModMeta

java.lang.Object
java.lang.Record
software.bluelib.api.event.mod.ModMeta
public record ModMeta(String modId, String displayName, String version, String description, Optional<String> logoFile) extends Record

  • Constructor Details

    • ModMeta

      public ModMeta(String modId, String displayName, String version, String description, Optional<String> logoFile)
      Creates an instance of a ModMeta record class.
      Parameters:
      modId - the value for the modId record component
      displayName - the value for the displayName record component
      version - the value for the version record component
      description - the value for the description record component
      logoFile - the value for the logoFile 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.

    • modId

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

    • displayName

      public String displayName()
      Returns the value of the displayName record component.
      Returns:
      the value of the displayName 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

    • logoFile

      public Optional<String> logoFile()
      Returns the value of the logoFile record component.
      Returns:
      the value of the logoFile record component