Record Class ModRecord

java.lang.Object
java.lang.Record
net.neoforged.neoforge.server.jsonrpc.ModRecord
public record ModRecord(String modId, String version, String displayName, String description) extends Record

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final com.mojang.serialization.Codec<ModRecord>
    CODEC
     
    private final String
    description
    The field for the description record component.
    private final String
    displayName
    The field for the displayName record component.
    private final String
    modId
    The field for the modId record component.
    private final String
    version
    The field for the version record component.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ModRecord(String modId, String version, String displayName, String description)
    Creates an instance of a ModRecord record class.
    ModRecord(IModInfo modInfo)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    description()
    Returns the value of the description record component.
    String
    displayName()
    Returns the value of the displayName record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    modId()
    Returns the value of the modId record component.
    final String
    toString()
    Returns a string representation of this record class.
    String
    version()
    Returns the value of the version record component.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • modId

      private final String modId
      The field for the modId record component.

    • version

      private final String version
      The field for the version record component.

    • displayName

      private final String displayName
      The field for the displayName record component.

    • description

      private final String description
      The field for the description record component.

    • CODEC

      public static final com.mojang.serialization.Codec<ModRecord> CODEC

  • Constructor Details

    • ModRecord

      public ModRecord(IModInfo modInfo)

    • ModRecord

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

    • version

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

    • displayName

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

    • description

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