Package com.tnsai.output.validation

Record Class StructuredOutputExecutor.StructuredOutputResult<T>

java.lang.Object
java.lang.Record
com.tnsai.output.validation.StructuredOutputExecutor.StructuredOutputResult<T>
Enclosing class:
StructuredOutputExecutor<T>
public static record StructuredOutputExecutor.StructuredOutputResult<T>(boolean success, T value, List<String> errors, int attempts) extends Record
Result of a structured output generation attempt.

  • Constructor Summary

    Constructors
    Constructor
    Description
    StructuredOutputResult(boolean success, T value, List<String> errors, int attempts)
    Creates an instance of a StructuredOutputResult record class.

  • Method Summary

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

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • StructuredOutputResult

      public StructuredOutputResult(boolean success, T value, List<String> errors, int attempts)
      Creates an instance of a StructuredOutputResult record class.
      Parameters:
      success - the value for the success record component
      value - the value for the value record component
      errors - the value for the errors record component
      attempts - the value for the attempts 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.

    • success

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

    • value

      public T value()
      Returns the value of the value record component.
      Returns:
      the value of the value record component

    • errors

      public List<String> errors()
      Returns the value of the errors record component.
      Returns:
      the value of the errors record component

    • attempts

      public int attempts()
      Returns the value of the attempts record component.
      Returns:
      the value of the attempts record component