Record Class CommandLineHelp

java.lang.Object
java.lang.Record
org.ek9lang.cli.CommandLineHelp
public record CommandLineHelp(String helpText) extends Record
Holds the command line help text only. There are quite a few options, so this encapsulates descriptions.

  • Constructor Details

    • CommandLineHelp

      public CommandLineHelp()

    • CommandLineHelp

      public CommandLineHelp(String helpText)
      Creates an instance of a CommandLineHelp record class.
      Parameters:
      helpText - the value for the helpText 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.

    • helpText

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