Package com.winterhavenmc.library.messagebuilder.models.language

Record Class InvalidMessageRecord

java.lang.Object
java.lang.Record
com.winterhavenmc.library.messagebuilder.models.language.InvalidMessageRecord
Record Components:
key - the ValidMessageKey that identifies the missing or failed message
reason - a description of why this message record is invalid
All Implemented Interfaces:
MessageRecord, SectionRecord
public record InvalidMessageRecord(RecordKey key, InvalidRecordReason reason) extends Record implements MessageRecord
A MessageRecord representing a missing or invalid entry from the MESSAGES section of a language file.

This class is returned by the MessageRecord.from(LegacyRecordKey, ConfigurationSection) factory method when the provided section is null, or when a parsing error occurs.

The reason field provides a human-readable explanation for why the record is considered invalid. This allows for safe logging, debugging, and non-fatal fallback behavior in the library's message pipeline.

Invalid message records are safe to pass around and will typically result in no message being rendered or sent when encountered.

See Also:

  • Constructor Details

    • InvalidMessageRecord

      public InvalidMessageRecord(RecordKey key, InvalidRecordReason reason)
      Creates an instance of a InvalidMessageRecord record class.
      Parameters:
      key - the value for the key record component
      reason - the value for the reason 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 RecordKey key()
      Returns the value of the key record component.
      Specified by:
      key in interface SectionRecord
      Returns:
      the value of the key record component

    • reason

      public InvalidRecordReason reason()
      Returns the value of the reason record component.
      Returns:
      the value of the reason record component