Record Class LoopEvaluationContext

java.lang.Object
java.lang.Record
com.agentforge4j.runtime.LoopEvaluationContext
Record Components:
state - the live state of the current run; never null
activeWorkflowId - the id of the innermost workflow currently executing (the root workflow id when no nested workflow has been entered); never blank

public record LoopEvaluationContext(WorkflowState state, String activeWorkflowId) extends Record
The read-only view of a run a LoopEvaluator needs to decide whether an LoopTerminationStrategy.EVALUATOR loop should terminate.

A narrow, exported view rather than the runtime's internal per-drive execution context (which is not exported, and carries mutation methods no evaluator needs): every module-path consumer that implements LoopEvaluator can construct or receive this type.

  • Constructor Details

    • LoopEvaluationContext

      public LoopEvaluationContext(WorkflowState state, String activeWorkflowId)
      Creates an instance of a LoopEvaluationContext record class.
      Parameters:
      state - the value for the state record component
      activeWorkflowId - the value for the activeWorkflowId 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.
    • state

      public WorkflowState state()
      Returns the value of the state record component.
      Returns:
      the value of the state record component
    • activeWorkflowId

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