Record Class ConfigDescription

java.lang.Object
java.lang.Record
johnsmith.configoverhauled.api.data.ConfigDescription
Record Components:
modId - The target namespace or mod identifier.
category - The top-level classification category containing the target group.
group - The structural grouping containing the target property.
property - The exact registry or resource name of the target property.
public record ConfigDescription(String modId, String category, String group, String property) extends Record
Defines the precise hierarchical coordinates required to locate, bind, or dynamically construct a configuration property.

  • Field Details

    • CODEC

      public static final com.mojang.serialization.Codec<ConfigDescription> CODEC
      Standard codec for network transmission and disk serialization of property coordinates.

  • Constructor Details

    • ConfigDescription

      public ConfigDescription(String modId, String category, String group, String property)
      Creates an instance of a ConfigDescription record class.
      Parameters:
      modId - the value for the modId record component
      category - the value for the category record component
      group - the value for the group record component
      property - the value for the property 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.

    • modId

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

    • category

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

    • group

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

    • property

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