Package com.tnsai.planning.llm

Record Class StepExecutionResult

java.lang.Object

java.lang.Record

com.tnsai.planning.llm.StepExecutionResult

Record Components:

success - whether the step executed successfully

output - output/result from the step execution

error - error message if execution failed (null on success)

public record StepExecutionResult(boolean success, String output, String error)
extends Record

Result of executing a single plan step.

Since:

0.3.0

See Also:

• StepExecutor
• AdaptiveReplanEngine

Constructor Summary

Constructors

Constructor	Description
StepExecutionResult(boolean success, String output, String error)	Creates an instance of a StepExecutionResult record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	error()	Returns the value of the error record component.
static StepExecutionResult	failure(String error)	Creates a failure result.
static StepExecutionResult	failure(String output, String error)	Creates a failure result with partial output.
final int	hashCode()	Returns a hash code value for this object.
String	output()	Returns the value of the output record component.
boolean	success()	Returns the value of the success record component.
static StepExecutionResult	success(String output)	Creates a successful result.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

StepExecutionResult

public StepExecutionResult(boolean success,
 String output,
 String error)

Creates an instance of a StepExecutionResult record class.

Parameters:

success - the value for the success record component

output - the value for the output record component

error - the value for the error record component

Method Details

success

public static StepExecutionResult success(String output)

Creates a successful result.

failure

public static StepExecutionResult failure(String error)

Creates a failure result.

failure

public static StepExecutionResult failure(String output,
 String error)

Creates a failure result with partial output.

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

output

public String output()

Returns the value of the output record component.

Returns:

the value of the output record component

error

public String error()

Returns the value of the error record component.

Returns:

the value of the error record component