Module jakarta.ai.agent
Package jakarta.ai.agent

Record Class Result

java.lang.Object
java.lang.Record
jakarta.ai.agent.Result
Record Components:
success - true if the decision or step succeeded, false otherwise. When used as a @Decision return type, true means the workflow proceeds and false stops it.
details - can hold additional information, such as error messages, domain objects, or context.
public record Result(boolean success, Object details) extends Record
Represents the result of a decision or workflow step in an agent.
Since:
1.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    Result(boolean success, Object details)
    Creates an instance of a Result record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    details()
    Returns the value of the details record component.
    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.
    boolean
    success()
    Returns the value of the success 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

    • Result

      public Result(boolean success, Object details)
      Creates an instance of a Result record class.
      Parameters:
      success - the value for the success record component
      details - the value for the details 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

    • details

      public Object details()
      Returns the value of the details record component.
      Returns:
      the value of the details record component