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

Record Class InvalidConstantRecord

java.lang.Object
java.lang.Record
com.winterhavenmc.library.messagebuilder.models.language.InvalidConstantRecord
Record Components:
key - the ConstantKey identifying the invalid constant
reason - the explanation for why this record is invalid
All Implemented Interfaces:
ConstantRecord, SectionRecord
public record InvalidConstantRecord(RecordKey key, InvalidRecordReason reason) extends Record implements ConstantRecord
A ConstantRecord representing a missing or invalid constant from the CONSTANTS section of a language YAML file.

This record is typically returned by ConstantRecord.of(ValidConstantKey, Object) when a constant entry is null, missing, or otherwise unusable.

The reason field provides a human-readable description of the failure, which may be useful for debugging, logging, or diagnostics.

This record is safe to return and pass through the message pipeline, and will not result in runtime exceptions when encountered.

See Also:

  • Constructor Details

    • InvalidConstantRecord

      public InvalidConstantRecord(RecordKey key, InvalidRecordReason reason)
      Creates an instance of a InvalidConstantRecord 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