Package com.tnsai.environment

Record Class ActionOutcome

java.lang.Object

java.lang.Record

com.tnsai.environment.ActionOutcome

public record ActionOutcome(boolean success, String description, Percept resultingPercept)
extends Record

Result of an agent acting on the environment.

Constructor Summary

Constructors

Constructor	Description
ActionOutcome(boolean success, String description, Percept resultingPercept)	Creates an instance of a ActionOutcome record class.

Method Summary

Modifier and Type	Method	Description
String	description()	Returns the value of the description record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static ActionOutcome	failure(String description)
Optional<Percept>	getResultingPercept()
final int	hashCode()	Returns a hash code value for this object.
Percept	resultingPercept()	Returns the value of the resultingPercept record component.
boolean	success()	Returns the value of the success record component.
static ActionOutcome	success(String description)
static ActionOutcome	success(String description, Percept percept)
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

ActionOutcome

public ActionOutcome(boolean success,
 String description,
 Percept resultingPercept)

Creates an instance of a ActionOutcome record class.

Parameters:

success - the value for the success record component

description - the value for the description record component

resultingPercept - the value for the resultingPercept record component

Method Details

success

public static ActionOutcome success(String description,
 Percept percept)

success

public static ActionOutcome success(String description)

failure

public static ActionOutcome failure(String description)

getResultingPercept

public Optional<Percept> getResultingPercept()

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

description

public String description()

Returns the value of the description record component.

Returns:

the value of the description record component

resultingPercept

public Percept resultingPercept()

Returns the value of the resultingPercept record component.

Returns:

the value of the resultingPercept record component