Package io.github.nacvark.hudengine.api

Record Class HudEngine.ReloadResult

java.lang.Object
java.lang.Record
io.github.nacvark.hudengine.api.HudEngine.ReloadResult
Record Components:
messages - lines describing what happened, already localised, suitable to show a player
Enclosing interface:
HudEngine
public static record HudEngine.ReloadResult(boolean success, List<String> messages) extends Record
The outcome of a reload.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ReloadResult(boolean success, List<String> messages)
    Creates an instance of a ReloadResult 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.
    List<String>
    messages()
    Returns the value of the messages record component.
    boolean
    success()
    Returns the value of the success record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ReloadResult

      public ReloadResult(boolean success, List<String> messages)
      Creates an instance of a ReloadResult record class.
      Parameters:
      success - the value for the success record component
      messages - the value for the messages 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • success

      public boolean success()
      Returns the value of the success record component.
      Returns:
      the value of the success record component

    • messages

      public List<String> messages()
      Returns the value of the messages record component.
      Returns:
      the value of the messages record component