Record Class HelpTarget

java.lang.Object
java.lang.Record
com.kingsrook.qqq.backend.core.actions.help.HelpTarget
public record HelpTarget(String kind, String key, String name, String table, String process, String label, String parentKey, boolean hidden, List<QHelpContent> contents, Object owner) extends Record
An addressable help target. Contents reference shared metadata; consumers copy.

  • Constructor Details

    • HelpTarget

      public HelpTarget(String kind, String key, String name, String table, String process, String label, String parentKey, boolean hidden, List<QHelpContent> contents, Object owner)
      Creates an instance of a HelpTarget record class.
      Parameters:
      kind - the value for the kind record component
      key - the value for the key record component
      name - the value for the name record component
      table - the value for the table record component
      process - the value for the process record component
      label - the value for the label record component
      parentKey - the value for the parentKey record component
      hidden - the value for the hidden record component
      contents - the value for the contents record component
      owner - the value for the owner 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      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.

    • kind

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

    • key

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

    • name

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

    • table

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

    • process

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

    • label

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

    • parentKey

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

    • hidden

      public boolean hidden()
      Returns the value of the hidden record component.
      Returns:
      the value of the hidden record component

    • contents

      public List<QHelpContent> contents()
      Returns the value of the contents record component.
      Returns:
      the value of the contents record component

    • owner

      public Object owner()
      Returns the value of the owner record component.
      Returns:
      the value of the owner record component