Record Class ModContext

java.lang.Object
java.lang.Record
com.hloader.mod.ModContext
public record ModContext(String modId, String modVersion) extends Record
Handed to a mod's lifecycle methods so it can log and identify itself.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ModContext(String modId, String modVersion)
    Creates an instance of a ModContext record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    void
    log(String message)
     
    String
    modId()
    Returns the value of the modId record component.
    String
    modVersion()
    Returns the value of the modVersion record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

  • Constructor Details

    • ModContext

      public ModContext(String modId, String modVersion)
      Creates an instance of a ModContext record class.
      Parameters:
      modId - the value for the modId record component
      modVersion - the value for the modVersion record component

  • Method Details

    • log

      public void log(String message)

    • 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

    • modVersion

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