Package com.tnsai.planning

Record Class PlannerHandle.StepResult

java.lang.Object

java.lang.Record

com.tnsai.planning.PlannerHandle.StepResult

Record Components:

actionName - the action that was executed

executed - true if the action ran successfully

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

Enclosing interface:

PlannerHandle

public static record PlannerHandle.StepResult(String actionName, boolean executed, String error)
extends Record

Result of executing a single plan step.

Constructor Summary

Constructors

Constructor	Description
StepResult(String actionName, boolean executed, String error)	Creates an instance of a StepResult record class.

Method Summary

Modifier and Type	Method	Description
String	actionName()	Returns the value of the actionName record component.
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.
boolean	executed()	Returns the value of the executed record component.
static PlannerHandle.StepResult	failure(String actionName, String error)	Creates a failed step result.
final int	hashCode()	Returns a hash code value for this object.
static PlannerHandle.StepResult	success(String actionName)	Creates a successful step 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

StepResult

public StepResult(String actionName,
 boolean executed,
 String error)

Creates an instance of a StepResult record class.

Parameters:

actionName - the value for the actionName record component

executed - the value for the executed record component

error - the value for the error record component

Method Details

success

public static PlannerHandle.StepResult success(String actionName)

Creates a successful step result.

failure

public static PlannerHandle.StepResult failure(String actionName,
 String error)

Creates a failed step result.

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.

actionName

public String actionName()

Returns the value of the actionName record component.

Returns:

the value of the actionName record component

executed

public boolean executed()

Returns the value of the executed record component.

Returns:

the value of the executed record component

error

public String error()

Returns the value of the error record component.

Returns:

the value of the error record component