Record Class PromptAssist.Option.InsertOrDrillIn

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.designer.ai.embed.PromptAssist.Option.InsertOrDrillIn
Record Components:
path - the portion of the token after the @<id>: prefix, spliced on confirm. Same rules as PromptAssist.Option.Insert.path().
body - supplier the framework calls at submit time to resolve the reference's body. Same rules as PromptAssist.Option.Insert.body().
nextQuery - the new query string the framework issues on expand. Same rules as PromptAssist.Option.DrillIn.nextQuery().
All Implemented Interfaces:
PromptAssist.Option
Enclosing interface:
PromptAssist.Option

public static record PromptAssist.Option.InsertOrDrillIn(String label, @Nullable String detail, String path, Supplier<ReferenceBody> body, String nextQuery) extends Record implements PromptAssist.Option
A row that is both confirmable and expandable. Carries the PromptAssist.Option.Insert payload (so Enter or a body click splices @<id>:<path> and registers a reference) and the PromptAssist.Option.DrillIn payload (so Tab or a chevron click rewrites the query to nextQuery). Use when a tree node should also be referenceable in its own right — e.g. a table whose columns are children, or a property container whose keys are children.
  • Constructor Details

    • InsertOrDrillIn

      public InsertOrDrillIn(String label, @Nullable String detail, String path, Supplier<ReferenceBody> body, String nextQuery)
      Creates an instance of a InsertOrDrillIn record class.
      Parameters:
      label - the value for the label record component
      detail - the value for the detail record component
      path - the value for the path record component
      body - the value for the body record component
      nextQuery - the value for the nextQuery 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.
    • label

      public String label()
      Returns the value of the label record component.
      Specified by:
      label in interface PromptAssist.Option
      Returns:
      the value of the label record component
    • detail

      public @Nullable String detail()
      Returns the value of the detail record component.
      Specified by:
      detail in interface PromptAssist.Option
      Returns:
      the value of the detail record component
    • path

      public String path()
      Returns the value of the path record component.
      Returns:
      the value of the path record component
    • body

      public Supplier<ReferenceBody> body()
      Returns the value of the body record component.
      Returns:
      the value of the body record component
    • nextQuery

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