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

Record Class CompleteCommand

java.lang.Object
java.lang.Record
com.agentforge4j.core.command.CompleteCommand
All Implemented Interfaces:
LlmCommand
public record CompleteCommand(String summary) extends Record implements LlmCommand
Signal that the current step or loop iteration is complete.

Used as the termination signal when LoopTerminationStrategy.AGENT_SIGNAL is in effect. The optional summary is recorded on the event log.

  • Constructor Summary

    Constructors
    Constructor
    Description
    CompleteCommand(String summary)
    Creates an instance of a CompleteCommand 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
    summary()
    Returns the value of the summary 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

    • CompleteCommand

      public CompleteCommand(String summary)
      Creates an instance of a CompleteCommand record class.
      Parameters:
      summary - the value for the summary 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.

    • summary

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