Package com.github.joschi.jadconfig.documentation

Record Class ConfigurationEntryWithSection

java.lang.Object
java.lang.Record
com.github.joschi.jadconfig.documentation.ConfigurationEntryWithSection
public record ConfigurationEntryWithSection(ConfigurationEntry entry, String sectionHeading, String sectionDescription) extends Record

  • Constructor Details

    • ConfigurationEntryWithSection

      public ConfigurationEntryWithSection(ConfigurationEntry entry, String sectionHeading, String sectionDescription)
      Creates an instance of a ConfigurationEntryWithSection record class.
      Parameters:
      entry - the value for the entry record component
      sectionHeading - the value for the sectionHeading record component
      sectionDescription - the value for the sectionDescription record component

  • Method Details

    • hasSection

      public boolean hasSection()

    • 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.

    • entry

      public ConfigurationEntry entry()
      Returns the value of the entry record component.
      Returns:
      the value of the entry record component

    • sectionHeading

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

    • sectionDescription

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