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

Record Class InvalidItemRecord

java.lang.Object
java.lang.Record
com.winterhavenmc.library.messagebuilder.models.language.InvalidItemRecord
Record Components:
key - the ValidItemKey that could not be resolved
reason - an explanation of why the record is invalid (e.g., missing section)
All Implemented Interfaces:
ItemRecord, SectionRecord
public record InvalidItemRecord(RecordKey key, InvalidRecordReason reason) extends Record implements ItemRecord
An ItemRecord representing a missing or invalid item entry from the ITEMS section of a language YAML file.

This record is typically returned by ItemRecord.from(LegacyRecordKey, ConfigurationSection) when the associated configuration section is null or otherwise unusable.

The reason field provides a human-readable explanation of the failure, useful for diagnostics or logging, but is not required for program logic.

This record is safe to pass through all systems in the library, and guarantees that item-related logic does not throw NullPointerException due to missing configurations.

See Also:

  • Constructor Details

    • InvalidItemRecord

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