Module agentforge4j.core
Package com.agentforge4j.core.command

Record Class UserPromptCommand

java.lang.Object
java.lang.Record
com.agentforge4j.core.command.UserPromptCommand
All Implemented Interfaces:
LlmCommand
public record UserPromptCommand(String message, boolean responseRequired) extends Record implements LlmCommand
Surface a message to the user. When responseRequired is true, the runtime pauses execution and waits for user input.

  • Constructor Summary

    Constructors
    Constructor
    Description
    UserPromptCommand(String message, boolean responseRequired)
    Creates an instance of a UserPromptCommand record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    message()
    Returns the value of the message record component.
    boolean
    responseRequired()
    Returns the value of the responseRequired record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • UserPromptCommand

      public UserPromptCommand(String message, boolean responseRequired)
      Creates an instance of a UserPromptCommand record class.
      Parameters:
      message - the value for the message record component
      responseRequired - the value for the responseRequired 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 '=='.
      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.

    • message

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

    • responseRequired

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