Record Class PromptAssist.Option.Insert

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.designer.ai.embed.PromptAssist.Option.Insert
Record Components:
path - the portion of the token after the @<id>: prefix — the assist's own addressing scheme (e.g. [default]Tank/Level, docs/Readme.md, Container1.Button1). The assist never includes the prefix; the framework owns the token grammar.
body - supplier the framework calls on the EDT at submit time to resolve the reference's body. Should be cheap or cached; expensive resolution should happen inside PromptAssist.options(String) and be captured by this supplier as a closed-over value.
All Implemented Interfaces:
PromptAssist.Option
Enclosing interface:
PromptAssist.Option

public static record PromptAssist.Option.Insert(String label, @Nullable String detail, String path, Supplier<ReferenceBody> body) extends Record implements PromptAssist.Option
A terminal row: selecting it splices @<id>:<path> — built by the framework from the owning assist's PromptAssist.id() and this row's path — into the prompt at the trigger span, closes the popup, and registers a ContextReference the framework resolves at submit time.
  • Constructor Details

    • Insert

      public Insert(String label, @Nullable String detail, String path, Supplier<ReferenceBody> body)
      Creates an instance of a Insert 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
  • 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