Package za.co.wethinkcode.robots.domain

Record Class HelpStruct

java.lang.Object
java.lang.Record
za.co.wethinkcode.robots.domain.HelpStruct
Record Components:
usage -
description -
public record HelpStruct(String usage, String description) extends Record
Help Struct stores all the information that an ImplementedClientCommands needs to be rendered in a helpful way

  • Constructor Details

    • HelpStruct

      public HelpStruct(String usage, String description)
      Creates an instance of a HelpStruct record class.
      Parameters:
      usage - the value for the usage record component
      description - the value for the description record component

  • Method Details

    • toString

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

    • usage

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

    • description

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